Skip to content

docs: cross-reference nth-fibonacci implementations via javadocs#7497

Open
DishaSethi wants to merge 2 commits into
TheAlgorithms:masterfrom
DishaSethi:docs-link-fibonacci-variants
Open

docs: cross-reference nth-fibonacci implementations via javadocs#7497
DishaSethi wants to merge 2 commits into
TheAlgorithms:masterfrom
DishaSethi:docs-link-fibonacci-variants

Conversation

@DishaSethi

@DishaSethi DishaSethi commented Jun 26, 2026

Copy link
Copy Markdown
  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized it.
  • All filenames are in PascalCase.
  • All functions and variable names follow Java naming conventions.
  • All new algorithms have a URL in their comments that points to Wikipedia or other similar explanations. (N/A - Documentation update only)
  • All new algorithms include a corresponding test class that validates their functionality. (N/A - Documentation update only)
  • All new code is formatted with clang-format -i --style=file path/to/your/file.java

Description

The n-th Fibonacci sequence is implemented across several files using entirely different paradigms (Iterative, Streams, Binet's Formula, Recursion, and DP). Currently, a learner looking at one file has no way of knowing the other approaches exist.

Proposed change

Added standard Javadoc {@link} cross-references to the header of the following files:

  • maths/FibonacciLoop.java
  • maths/FibonacciJavaStreams.java
  • maths/FibonacciNumberCheck.java
  • maths/FibonacciNumberGoldenRation.java
  • dynamicprogramming/Fibonacci.java
  • recursion/FibonacciSeries.java

This drastically improves discoverability for learners trying to compare algorithmic approaches, without disrupting the existing package hierarchy.
Fixes #7455

@codecov-commenter

codecov-commenter commented Jun 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.92%. Comparing base (ef986c4) to head (af1488c).

Additional details and impacted files
@@             Coverage Diff              @@
##             master    #7497      +/-   ##
============================================
+ Coverage     79.91%   79.92%   +0.01%     
- Complexity     7353     7356       +3     
============================================
  Files           811      811              
  Lines         23879    23879              
  Branches       4705     4705              
============================================
+ Hits          19082    19086       +4     
+ Misses         4036     4035       -1     
+ Partials        761      758       -3     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@DishaSethi DishaSethi marked this pull request as ready for review June 26, 2026 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Consolidate or cross-reference the scattered Fibonacci implementations

2 participants