unisonweb/unison

the `patch` command help doesn't list its arguments or give examples

Open

#908 opened on Oct 29, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Haskell (304 forks)batch import
codebase-manager / ucmdocumentationhelp wantedpapercut

Repository metrics

Stars
 (6,624 stars)
PR merge metrics
 (Avg merge 12d 19h) (6 merged PRs in 30d)

Description

patch takes a mandatory patch argument and an optional scope path argument, but the help examples don't mention or illustrate them.

https://github.com/unisonweb/unison/blob/6e37d28e80c615820fbea6a7e90f37e7f07cac5c/parser-typechecker/src/Unison/CommandLine/InputPatterns.hs#L169-L192

See the update command for examples of examples: https://github.com/unisonweb/unison/blob/6e37d28e80c615820fbea6a7e90f37e7f07cac5c/parser-typechecker/src/Unison/CommandLine/InputPatterns.hs#L146-L156

Contributor guide

Research direction
Edit the help text for the `patch` command in InputPatterns.hs to include arguments and examples, following the pattern of the `update` command.
Tech stack
haskell
Domain
cli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90