uutils / uutils/coreutils

Some docs issues

Open
#5,692 14 comments 2 reactions 0 assignees View on GitHub

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:

  • join should be join [OPTION]... FILE1 FILE2
  • cut should be cut OPTION... [FILE]...
  • mkdir should be mkdir [OPTION]... DIRECTORY... (for some reason it says [USER] now 😄 )
  • The usage string for everything based on hashsum are missing.
  • more now says more [OPTIONS] <FILE>... which matches util-linux but uses a different syntax than GNU, which would be more [OPTIONS]... FILE...
  • nohup FLAG should be nohup OPTION
  • pr should be pr [OPTION]... [FILE]...
  • printenv should be printenv [OPTION]... [VARIABLE]...
  • printf should have the strings printf FORMAT [ARGUMENT]... and printf OPTION
  • basenc has a " at the end of the usage string that shouldn't be there.
  • runcon has "; at the end of the usage string that shouldn't be there.
  • shuf has ; at the end of the usage string that shouldn't be there.
  • sum has " 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 of test.
  • uniq should be uniq [OPTION]... [INPUT [OUTPUT]]
  • unlink should be unlink FILE and unlink OPTION
  • vdir is missing documentation

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.