Some docs issues
Open
Nobody has claimed this yet.
good first issue
- Dominant language
- Rust
- Stars
- 24.1k
- Forks
- 2k
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 365
Description
I'm going through all signatures for the argument parser. I found some issues in the docs:
-
joinshould bejoin [OPTION]... FILE1 FILE2 -
cutshould becut OPTION... [FILE]... -
mkdirshould bemkdir [OPTION]... DIRECTORY...(for some reason it says[USER]now 😄 ) -
The usage string for everything based onhashsumare missing. -
morenow saysmore [OPTIONS] <FILE>...which matchesutil-linuxbut uses a different syntax than GNU, which would bemore [OPTIONS]... FILE... -
nohup FLAGshould benohup OPTION -
prshould bepr [OPTION]... [FILE]... -
printenvshould beprintenv [OPTION]... [VARIABLE]... -
printfshould have the stringsprintf FORMAT [ARGUMENT]...andprintf OPTION -
basenchas a"at the end of the usage string that shouldn't be there. -
runconhas";at the end of the usage string that shouldn't be there. -
shufhas;at the end of the usage string that shouldn't be there. -
sumhas"at the end of the usage string that shouldn't be there. - The last three lines of
test's usage string should be written with[instead oftest. -
uniqshould beuniq [OPTION]... [INPUT [OUTPUT]] -
unlinkshould beunlink FILEandunlink OPTION -
vdiris missing documentation
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Use the issue checklist to identify the remaining work: usage strings for utilities based on hashsum, the final lines of test's usage string, and missing vdir documentation. Locate the argument-parser documentation or command definitions, verify the existing completed entries for consistency, and consider the work done when the unchecked items match the requested signatures and documentation style.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100