docs: Fix formatting of example section in docstring #1333
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
Coverage Report for backend
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
thomass-dev
reviewed
Feb 18, 2025
Comment on lines
-48
to
+51
| >>> | ||
| >> import skore | ||
| >> | ||
| >> project = skore.Project("my-xp") | ||
| >> project.put("score", 1.0) | ||
| >> project.get("score") | ||
| >>> import skore | ||
| >>> project = skore.Project("my-xp") | ||
| >>> project.put("score", 1.0) | ||
| >>> project.get("score") |
There was a problem hiding this comment.
This was intentionally done to avoid running this doctest.
There was a problem hiding this comment.
In this case we need # +SKIP
There was a problem hiding this comment.
We can't skip an entire block with only one instruction :(
There was a problem hiding this comment.
We would need the following package: https://github.com/scipy/scipy_doctest
I think it allows to skip for an entire block. Also it could be nice because it deals properly with the float numbers check.
There was a problem hiding this comment.
Should I create a separate issue for this?
There was a problem hiding this comment.
Yep you can do that. I'm not sure how much work does it involves but it should quite straightforward.
There was a problem hiding this comment.
Done, here is the issue: #1347
thomass-dev
pushed a commit
that referenced
this pull request
Feb 18, 2025
Follow-up #1333 Avoid to execute the `project.put` and `project.get` in the docstring of `Project`.
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.
closes #1326
Fixing formatting in "Examples" section some method classes.