{{ message }}
Correct README.md examples and outputs using doctest#351
Merged
Conversation
Owner
pjkundert
force-pushed
the
fix/readme-doctest
branch
from
04f7374 to
232ed74
Compare
Contributor
Author
|
This includes a modification of _isnumber; it is logically equivalent, except that it has an explicit "fast path" for raw int and float values. It is (now) in the same logical form as _isint, and appears a bit more complex, but is otherwise logically unchanged. I have added a section to the README discussing type deduction, and how to handle types that convert to int or float but where the str representation is desired by the user. Also, @astanin, I noticed while testing this that, if |
Owner
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The 'README.md' contains numerous examples and expected outputs, but these don't appear to be regularly tested.
I added the formatting necessary to run "doctest" on the README.md and test the expected outputs. Mostly this was just adding a doctest-terminating blank line after the expected outputs. However, several of the tests showed some differences in output.
Check that these are indeed now correct, and then this should be ready to merge.
I also added instructions on how to run doctest on the
README.md.