Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

minor docs and help text improvements #66

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

minor docs and help text improvements #66

wants to merge 3 commits into from

Commits on Dec 14, 2019

  1. help: print help text as text, not html 

    Before:

$ gohack help get
[snip]
It uses $GOHACK/<module> as the destination directory,
or $HOME/gohack/<module> if $GOHACK is empty.
[snip]

No need to escape html entities for the terminal. :)
    @josharian
    josharian committed Dec 14, 2019
    Configuration menu
    Copy the full SHA
    bd00af3 View commit details
    Browse the repository at this point in the history

  2. help: remove -u from list of get flags in docs 

    Since -u hasn't been implemented yet,
we shouldn't advertise it in the help text.
    @josharian
    josharian committed Dec 14, 2019
    Configuration menu
    Copy the full SHA
    f5298cc View commit details
    Browse the repository at this point in the history

  3. delete large todo about subcommands 

    Subcommands have been introduced.
They don't perfectly match this structure,
but it is reasonably close.
The TODO comment contains a few as-yet unimplemented
ideas for other features and subcommands:

* get -u already has a todo in the get flags
* rm isn't implemented, but it is also not likely to be forgotten if/when it is needed
* dir has lots of overlap with rogpeppe#61, and the issue tracker is a better place to discuss

Given that, the outdated comment no longer pulls its weight. Cull it.
    @josharian
    josharian committed Dec 14, 2019
    Configuration menu
    Copy the full SHA
    a0664c0 View commit details
    Browse the repository at this point in the history