What would you like to suggest?
The rapid2 command-line program is missing several standard CLI features that users expect from modern command-line tools.
Missing Standard CLI Features:
--version / -V flag - No way to check the installed version
- Citation info - Not displayed when running without arguments or in help output (users should know how to cite RAPID2)
- Examples section - No usage examples in help text
- Descriptive help text - Current description ("This is RAPID2") is too minimal
- Exit codes documentation - Not documented (if used)
Minimal Recommendations to Implement:
-
Add --version flag
- Example:
parser.add_argument('--version', action='version', version='%(prog)s 2.0.0')
-
Improve program description
- Current: "This is RAPID2"
- Suggested: "RAPID2: Routing Application for Python Integration of Discharge - River routing model for streamflow computation"
-
Add epilog with usage example and citation info
- Show basic command example at bottom of help text
- Include reference to CITATION.cff for proper citation
What would you like to suggest?
The rapid2 command-line program is missing several standard CLI features that users expect from modern command-line tools.
Missing Standard CLI Features:
--version/-Vflag - No way to check the installed versionMinimal Recommendations to Implement:
Add
--versionflagparser.add_argument('--version', action='version', version='%(prog)s 2.0.0')Improve program description
Add epilog with usage example and citation info