Skip to content

Instantly share code, notes, and snippets.

@YumaInaura

YumaInaura/PROGRAMMING.md

Last active August 22, 2018 10:55
Show Gist options
  • Save YumaInaura/97e7ed6bfbd671213d57b7bba4e4816d to your computer and use it in GitHub Desktop.
Save YumaInaura/97e7ed6bfbd671213d57b7bba4e4816d to your computer and use it in GitHub Desktop.
Download ZIP
BEGISH — BEfore Google It See your Help ( Programming TIP )
Raw
PROGRAMMING.md

BEGISH — BEfore Google It See your Help ( Programming TIP )

Before Google it see your software's help. ( e.g command help )

The reason

  • Web information by your Googling is maybe not match for your versions or environment.
    • Maybe you use version 2.0.1 but web information describes about version 1.9.9.
    • Or reversibly you use version 1.9.9 but web information describes about version 2.0.1.
  • Web information is maybe not perfect.
    • For example some option is not in web help but in command help.
    • I think in many cases command help is newer than web help.
    • Command is also not perfect but it is trusty than others.

How to show command help?

The way to show help is depend on each command's "mood" (implement).

  • Some command provides help as short option.
  • Some command provides help as command arg.

e.g.

  • some/command -h
  • some/command --help
  • some/command help
  • some/command arg --help

Links

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment