Skip to content

Commit

Permalink
docs: Avoid creating project in docstring (#1341)
Browse files Browse the repository at this point in the history
Follow-up #1333 

Avoid to execute the `project.put` and `project.get` in the docstring of
`Project`.
  • Loading branch information
glemaitre authored Feb 18, 2025
1 parent 38b298b commit de3332e
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions skore/src/skore/project/project.py
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ class Project:
Examples
--------
>>> import skore
>>> project = skore.Project("my-xp")
>>> project.put("score", 1.0)
>>> project.get("score")
>>> project = skore.Project("my-xp") # doctest: +SKIP
>>> project.put("score", 1.0) # doctest: +SKIP
>>> project.get("score") # doctest: +SKIP
1.0
"""

Expand Down

0 comments on commit de3332e

Please sign in to comment.