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: Minor changes in the doc (tracking items example) #1124

Closed
sylvaincom opened this issue Jan 15, 2025 · 0 comments · Fixed by #1125
Closed

docs: Minor changes in the doc (tracking items example) #1124

sylvaincom opened this issue Jan 15, 2025 · 0 comments · Fixed by #1125
Assignees
@sylvaincom
Labels
documentation Improvements or additions to documentation

Comments

@sylvaincom
Copy link
Contributor

sylvaincom commented Jan 15, 2025 •
edited
Loading

Which part of the documentation needs improvement?

Tracking items example (user guide)

Describe the problem found in the documentation

Some minor changes to be made:

  • rename item_histories → item_versions
  • “we can print the details of the first version of this item”
  • rename passed_item → first_item
  • rename iteration_number → version_number
  • how, why → in bold
  • etc

Suggested improvement

No response

Additional context

No response
@sylvaincom sylvaincom added documentation Improvements or additions to documentation needs-triage This has been recently submitted and needs attention labels Jan 15, 2025
@sylvaincom sylvaincom self-assigned this Jan 15, 2025
@sylvaincom sylvaincom removed the needs-triage This has been recently submitted and needs attention label Jan 15, 2025
@sylvaincom sylvaincom mentioned this issue Jan 15, 2025
Merged
@sylvaincom sylvaincom linked a pull request Jan 15, 2025 that will close this issue
docs: Minor changes in the doc (tracking items example) #1125
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sylvaincom sylvaincom

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Minor changes in the doc (tracking items example) probabl-ai/skore
1 participant
@sylvaincom