Skip to content

Fix doctest tracebacks #7558

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 1 commit into from
Oct 23, 2022
Merged

Fix doctest tracebacks #7558

merged 1 commit into from
Oct 23, 2022

Conversation

CaedenPH
Copy link
Contributor

Describe your change:

Replace File "/usr/bin..." with ...

  • 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}.

@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, 2022
cclauss
cclauss reviewed Oct 23, 2022
View reviewed changes
ciphers/decrypt_caesar_with_chi_squared.py Outdated
@@ -122,6 +122,7 @@ def decrypt_caesar_with_chi_squared(

>>> decrypt_caesar_with_chi_squared(12)
Traceback (most recent call last):
...
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please indent four spaces like the doctest docs do.

cclauss
cclauss reviewed Oct 23, 2022
View reviewed changes
quantum/superdense_coding.py Outdated
@@ -92,7 +92,7 @@ def superdense_coding(bit_1: int = 1, bit_2: int = 1) -> qiskit.result.counts.Co
# measure the circuit
quantum_circuit.measure(qr, cr)

backend = Aer.get_backend("qasm_simulator")
backend = Aer.get_backend("aer_simulator")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change was already merged?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change was already merged?

Must've forgotten to fetch

@CaedenPH CaedenPH closed this Oct 23, 2022
@CaedenPH CaedenPH reopened this Oct 23, 2022
@CaedenPH
Copy link
Contributor Author

@cclauss Should I go through every doctest and indent each ... by a tab? Lots of the doctests in this repo follow

>>> x
Traceback (most recent call last):
...

@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Oct 23, 2022
@cclauss cclauss merged commit 393b960 into TheAlgorithms:master Oct 23, 2022
@CaedenPH CaedenPH deleted the fix-doctest-tb branch October 23, 2022 14:37
@cclauss
Copy link
Member

cclauss commented Oct 23, 2022

Optional to modify all files. I think the adoption of pyproject.toml is a higher priority.

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
@CaedenPH @cclauss