From 057bb3494c58e14ce98ae1a391ca86361ad7cf82 Mon Sep 17 00:00:00 2001 From: Mike Pilgrem Date: Sat, 18 May 2024 15:19:50 +0100 Subject: [PATCH] Re #6581 Backport documentation improvements --- doc/global_flags.md | 6 +++--- doc/other_resources.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/global_flags.md b/doc/global_flags.md index 6751f243a1..7018583a8e 100644 --- a/doc/global_flags.md +++ b/doc/global_flags.md @@ -345,7 +345,7 @@ Default: `https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots The `--snapshot-location-base ` command option specifies the base location of snapshots. -## `--help` command flag +## `--help` or `-h` command flags -If Stack is passed the `--help` command flag, it will output help for the -command. +If Stack is passed the `--help` (or `-h`) command flag, it will output help for +the command. diff --git a/doc/other_resources.md b/doc/other_resources.md index a0de243985..c3f506ce8e 100644 --- a/doc/other_resources.md +++ b/doc/other_resources.md @@ -6,8 +6,8 @@ There are lots of resources available for learning more about Stack: * `stack` or `stack --help` — lists Stack's commands, and flags and options common to those commands -* `stack --help` — provides help on the particular Stack command, - including flags and options specific to the command +* `stack --help` (or `-h`) — provides help on the particular Stack + command, including flags and options specific to the command * `stack --version` — identify the version and Git hash of the Stack executable * `--verbose` (or `-v`) — much more info about internal operations (useful for bug reports)