commercetest / commercetest/nlnet

Clarify and be consistent in the help messages for command-line flags

Open
#54 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

### Context
While I've been reviewing PRs I noticed various help strings that conflate paths and files. I'd like the help messages to be clearer and to be consistent in their use of terms. It'd be useful to also check the project's README mentions command-line flags and how to see them from the command line (e.g. via a `--help` and/or a `--usage`).

Contributor guide

No contributing guide indexed for this repository

Research direction

Inspect the command-line flag help strings and the project's README, focusing first on how the CLI exposes --help or --usage. Standardize the terminology for paths and files in the help messages, and document how to view the available flags in the README.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.