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

docs: Docstring examples are broken #1326

Closed
auguste-probabl opened this issue Feb 14, 2025 · 0 comments · Fixed by #1333
Closed

docs: Docstring examples are broken #1326

auguste-probabl opened this issue Feb 14, 2025 · 0 comments · Fixed by #1333
Labels
documentation Improvements or additions to documentation needs-triage This has been recently submitted and needs attention

Comments

@auguste-probabl
Copy link
Contributor

auguste-probabl commented Feb 14, 2025 •
edited
Loading

Doctests are not rendered as code blocks. See for example the latest version of the docs:

Image

Already occurs in version 0.6 of the docs (https://skore.probabl.ai/0.6/generated/skore.Project.html#skore.Project.get_note)
@auguste-probabl auguste-probabl added documentation Improvements or additions to documentation needs-triage This has been recently submitted and needs attention labels Feb 14, 2025
@glemaitre glemaitre mentioned this issue Feb 15, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation needs-triage This has been recently submitted and needs attention
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Fix formatting of example section in docstring glemaitre/skore
1 participant
@auguste-probabl