document that flag descriptions cannot have commas
Open
- Dominant language
- Go
- Stars
- 507
- Forks
- 49
- PR merge metrics
- No merged PRs in 30d
Description
The new feature that allows flags to have descriptions precludes them having a comma in.
We should document that restriction.
Contributor guide
No contributing guide indexed for this repository
Research direction
Locate the existing documentation for flag descriptions in the repository and read how the new description feature is currently explained. Update that documentation to state that descriptions cannot contain commas, then verify the restriction is clearly and unambiguously documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100