Skip to content

Added doctests for fibonacci.py #10836

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 11 commits into from
Oct 29, 2023
Merged

Added doctests for fibonacci.py #10836

merged 11 commits into from
Oct 29, 2023

Conversation

nkstonks
Copy link
Contributor

@nkstonks nkstonks commented Oct 23, 2023 •
edited
Loading

Describe your change:

#9943

Added doctests for the fib_recursive_term function in maths/fibonacci.py

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@algorithms-keeper algorithms-keeper bot added enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed labels Oct 23, 2023
@nkstonks
Copy link
Contributor Author

Hold on, doctest seems to not be testing the function in question, I believe it's because it's a nested function. I'll need to figure something out for that.

Sorry for not checking this properly.

@nkstonks nkstonks closed this Oct 23, 2023
@nkstonks nkstonks reopened this Oct 24, 2023
@nkstonks
Copy link
Contributor Author

I closed this pull request as I realised doctest wasn't properly testing the function (fib_recursive_term) I implemented doctests for.

However I found out that doctests doesn't test local functions, which was the function I implemented doctests for.

So I'm reopening this pull request to ask whether we need to implement a way doctest will actually test that function, or just merge it anyways as the doctests are working (I've tested the function in a separte isolated file).

@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 29, 2023
@cclauss cclauss merged commit 6b588e4 into TheAlgorithms:master Oct 29, 2023
sedatguzelsemme pushed a commit to sedatguzelsemme/Python that referenced this pull request Sep 15, 2024
@nkstonks @cclauss
@pre-commit-ci @sedatguzelsemme
Added doctests for fibonacci.py (TheAlgorithms#10836)
a52908b 
* added other possible cases

* added test for correct output of truth table

* few fibonacci tests added

* updating DIRECTORY.md

* Update nor_gate.py

* updating DIRECTORY.md

* Update fibonacci.py

removed whitespace

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: = <=>
Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
Co-authored-by: Christian Clauss <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
@isidroas isidroas mentioned this pull request Jan 25, 2025
Closed
14 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss cclauss approved these changes

Assignees
No one assigned
Labels
enhancement This PR modified some existing files
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@nkstonks @cclauss