-
Notifications
You must be signed in to change notification settings - Fork 43
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.
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
improve cli documentation for questions #754
Conversation
rust/agama-cli/src/commands.rs
Outdated
/// Questions handling | ||
/// Configuration for questions that come from installer | ||
/// | ||
/// Questions are raised when unexpected situation happen in Installer |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/// Questions are raised when unexpected situation happen in Installer | |
/// Questions are raised when an unexpected situation happens in the installer: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well unexpected is wrong. It is expected, that's why we have coded a special case for it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yeah, I am not sure what is better word. Maybe "uncommon" or "rare"? not sure
/// It allows to predefine answers for certain questions to skip | ||
/// them in interactive mode or change answer in automatic mode. | ||
/// | ||
/// For more details and examples see official Agama documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd like to have a more helpful reference here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://github.com/openSUSE/agama/blob/master/doc/questions.md or anything else?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is what I am not sure if it will be documented on official suse side or not..and if it will be product specific or not.
Co-authored-by: Martin Vidner <mvidner@suse.cz>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have put the remaining info into the comments
Co-authored-by: Martin Vidner <mvidner@suse.cz>
Problem
There is insufficient documentation of questions CLI.
Solution
Improve it
Testing
Screenshots
Before:
After: