Skip to content
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

Fix documentation on [arithmetic_analysis] folder (#2510) #3274

Open
wants to merge 6 commits into
base: master
from

Conversation

@Ed1123
Copy link

@Ed1123 Ed1123 commented Oct 14, 2020

Describe your change:

I have reviewed all files in .../Python/arithmetic_analysis, added documentation, some tests and style according to the [CONTRIBUTING.md]. I've tried to keep most of the original code. Most of the changes are minimum and all of them can be reviewed in less than a minute. That's why I keep them all in just one PR.
#2510

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • 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 have a URL in its comments that points to Wikipedia or other similar explanation.
  • If this pull request resolves one or more open issues then the commit message contains Fixes: #{$ISSUE_NO}.
[Ed Brown] added 6 commits Oct 12, 2020
The 2 Newton-Raphson algorithms were working ok. I added some documentation and style to make the code more readable.
long correction
[Ed Brown]
@TravisBuddy
Copy link

@TravisBuddy TravisBuddy commented Oct 14, 2020

Travis tests have failed

Hey @Ed1123,
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: 26c27950-0dd0-11eb-9111-f326d0cb7f09
@Ed1123
Copy link
Author

@Ed1123 Ed1123 commented Oct 14, 2020

Apparently Travis CI is failing on a file I haven't modified:

=================================== FAILURES ===================================
_______________ [doctest] quantum.not_gate.single_qubit_measure _______________

Could you please check, @poyea? Sorry it I did something obvious wrong. this is my first PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.