Skip to content

/ Python

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.

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

added type hints and doctests to arithmetic_analysis/bisection.py #2241

Merged
merged 5 commits into from Jul 27, 2020
Merged

added type hints and doctests to arithmetic_analysis/bisection.py #2241

merged 5 commits into from Jul 27, 2020

Conversation

@spamegg1
Copy link
Contributor

spamegg1 commented Jul 27, 2020

continuing in line with #2128

Describe your change:

  • Fix a bug or typo in an existing algorithm?

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 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.
@spamegg1
added type hints and doctests to arithmetic_analysis/bisection.py
Loading status checks…
0aab12b 
continuing in line with #2128
@cclauss
cclauss reviewed Jul 27, 2020
View changes
arithmetic_analysis/bisection.py
if __name__ == "__main__":
print(bisection(f, 1, 1000))

This comment has been minimized.

Sign in to view
@cclauss

cclauss Jul 27, 2020

Member

Why remove this code?

This comment has been minimized.

Sign in to view
@spamegg1

spamegg1 Jul 27, 2020

Author Contributor

Hmm, I thought I was supposed to move all tests into the doctest. I guess I misunderstood. I can put it back in for sure.
@cclauss
cclauss reviewed Jul 27, 2020
View changes
arithmetic_analysis/bisection.py Outdated
print("couldn't find root in [a,b]")
return
# then this algorithm can't find the root
print("couldn't find root in [", a, ",", b, "]")

This comment has been minimized.

Sign in to view
@cclauss

cclauss Jul 27, 2020

Member

CONTRIBUTING.md says that algorithmic functions should not print. Please raise an exception instead of returning None.

This comment has been minimized.

Sign in to view
@spamegg1

spamegg1 Jul 27, 2020

Author Contributor

OK, got it.
@spamegg1
modified arithmetic_analysis/bisection.py
Loading status checks…
548e946 
Put back print statement at the end, replaced algorithm's print statement with an exception.
@TravisBuddy
Copy link

TravisBuddy commented Jul 27, 2020

Hey @spamegg1,
Something went wrong with the build.

TravisCI finished with status errored, which means the build failed because of something unrelated to the tests, such as a problem with a dependency or the build process itself.

View build log

TravisBuddy Request Identifier: c68a55b0-d005-11ea-81e3-a59d363db46c
@spamegg1
modified arithmetic_analysis/bisection.py
Loading status checks…
5b43859 
Removed unnecessary type import "Optional"
@cclauss
cclauss reviewed Jul 27, 2020
View changes
arithmetic_analysis/bisection.py Outdated
>>> bisection(lambda x: x ** 2 - 4 * x + 3, 4, 1000)
Traceback (most recent call last):
...
Exception: could not find root in given interval.

This comment has been minimized.

Sign in to view
@cclauss

cclauss Jul 27, 2020

Member

ValueError please, not generic Exception.

This comment has been minimized.

Sign in to view
@spamegg1

spamegg1 Jul 27, 2020

Author Contributor

OK.
spamegg1 added 2 commits Jul 27, 2020
@spamegg1
modified arithmetic_analysis/bisection.py
Loading status checks…
d580685 
Replaced generic Exception with ValueError.
@spamegg1
modified arithmetic_analysis/bisection.py
Loading status checks…
4c3358e 
fixed doctests
@spamegg1
Copy link
Contributor Author

spamegg1 commented Jul 27, 2020

My first time ever going through this CI process, I apologize for the mistakes and my too many commits. Thank you for your patience.
@TravisBuddy
Copy link

TravisBuddy commented Jul 27, 2020

Travis tests have failed

Hey @spamegg1,
Please read the following log in order to understand the failure reason.
It'll be awesome if you fix what's wrong and commit the changes.

TravisBuddy Request Identifier: 1d5a89d0-d008-11ea-81e3-a59d363db46c
@spamegg1
Copy link
Contributor Author

spamegg1 commented Jul 27, 2020 •
edited

Getting conflicting messages from Travis. It says tests failed, mentions a log but no link to it? And all checks have passed? I got the green check mark. Anyway, let me know what I should do.
@cclauss
cclauss approved these changes Jul 27, 2020
View changes
Copy link
Member

cclauss left a comment

Awesome work! Thanks.
@cclauss cclauss merged commit bd74f20 into TheAlgorithms:master Jul 27, 2020
2 checks passed
2 checks passed
codespell
Details
Travis CI - Pull Request Build Passed
Details
@spamegg1
Copy link
Contributor Author

spamegg1 commented Jul 27, 2020

Whew. That was quite stressful! I'll need a bit more practice with it. Thanks a lot, @cclauss
@NumberPiOso
Copy link
Contributor

NumberPiOso commented Jul 31, 2020

Getting conflicting messages from Travis. It says tests failed, mentions a log but no link to it? And all checks have passed? I got the green check mark. Anyway, let me know what I should do.

May you explain please what was the issue ?
@cclauss
Copy link
Member

cclauss commented Jul 31, 2020

https://github.com/TheAlgorithms/Python/blob/master/Travis_CI_tests_are_failing.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cclauss cclauss

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
@spamegg1 @TravisBuddy @NumberPiOso @cclauss
You can’t perform that action at this time.