docs: improve cli description - #57
Open
estellebertrand wants to merge 11 commits into
Open
Conversation
Updated command descriptions for clarity and consistency.
Updated command descriptions to clarify required parameters and improve user guidance.
Updated command descriptions for clarity and consistency.
Updated command descriptions for clarity and consistency.
Updated command descriptions for clarity and consistency.
Refactor topic commands for improved clarity and consistency.
Pierlou
requested changes
May 21, 2026
Pierlou
left a comment
Pierlou
left a comment
Collaborator
There was a problem hiding this comment.
Just quibbling around 🤓
| set: list[str] = typer.Option([], "--set"), | ||
| ) -> None: | ||
| """Update a dataset. Each `--set` option is expected as `<key>=<new_value>`.""" | ||
| """Update a dataset by `id`. Each `--set` option is expected as `<key>=<new_value>`.""" |
Collaborator
There was a problem hiding this comment.
I find it weird to have this syntax here while we have "id required" above, maybe we'd rather standardize that too
Contributor
Author
There was a problem hiding this comment.
Yes, i prefer the 'by id' version here, but i didn't know how to translate that in 'Display the main attributes of a dataset in a human-friendly format. id required.'
Maybe 'Display the main attributes of a dataset, looked up by id, in a human-friendly format.' but heavy
Co-authored-by: Pierlou Ramade <48205215+Pierlou@users.noreply.github.com>
Co-authored-by: Pierlou Ramade <48205215+Pierlou@users.noreply.github.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Fix a typo in "human-friendly"[not a typo] Use a more natural phrasing