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.

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

Add doctest to huffman #11253

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Add doctest to huffman #11253

wants to merge 7 commits into from

Conversation

Xceptions
Copy link

Describe your change:

Contributes to #9943

  • 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 the tests are failing Do not merge until tests pass label Jan 21, 2024
@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed and removed tests are failing Do not merge until tests pass labels Jan 21, 2024
@Xceptions
Copy link
Author

All the doctests are commented out because this algorithm returns dynamic values depending on different conditions. E.g. for the hoffman function, the encoding depends on how the 0s and 1s are assigned

tianyizheng02
tianyizheng02 requested changes Mar 27, 2024
View reviewed changes
Copy link
Contributor

@tianyizheng02 tianyizheng02 left a comment

Choose a reason for hiding this comment

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

  1. You said that the doctests are commented out because the results change based on the conditions. Where would these changes be coming from? I might be missing something, but I don't see any randomness being used in this implementation. If you know why the conditions are changing, then your doctests should set up the initial conditions so that results are consistent.
  2. Instead of reading the input from a file, could you directly pass in the input strings to your doctests? It avoids an I/O step that isn't crucial to the Huffman algorithm itself.

@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Mar 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tianyizheng02 tianyizheng02 tianyizheng02 requested changes

@imSanko imSanko imSanko approved these changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
awaiting reviews This PR is ready to be reviewed tests are failing Do not merge until tests pass
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@Xceptions @tianyizheng02 @imSanko