Doctest of example in README.rst #156
Merged
Conversation
This file contains 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
PicoCentauri
force-pushed
the
test-readme
branch
4 times, most recently
from
a6bcc69 to
0cadb48
Compare
GardevoirX
reviewed
Jan 24, 2025
There was a problem hiding this comment.
Would this be better? A suggestion from gpt
But the current state is still okay
There was a problem hiding this comment.
ahh I can try. Not sure if github/PyPI knows about the :hide: keyword. we will see.
There was a problem hiding this comment.
Update: Github just ignores this keyword. But nice try. Lets keep it like this for now and we can try to make it nicer later.
PicoCentauri
force-pushed
the
test-readme
branch
from
0cadb48 to
c675299
Compare
PicoCentauri
force-pushed
the
test-readme
branch
from
c675299 to
678a7bb
Compare
GardevoirX
approved these changes
Jan 24, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In #130 we changed the API of the tuning code and forgot to update the quickstart snippet in the
README.rst. We already fixed the syntax in #155 but to avoid this in the future, I added a doctest for this file.The only small bummer is that we have to add
>>>in every line to make the code recognized bypytest. Not super nice because if you copy the text you have to remove these characters by hand...Contributor (creator of pull-request) checklist
Reviewer checklist
📚 Documentation preview 📚: https://torch-pme--156.org.readthedocs.build/en/156/