Docs: assorted refinements for output #15986
Conversation
in particular, #generate_completions_from_executable
EricFromCanada
force-pushed
the
docs-assorted-improvements
branch
from
d87af8c
to
5858a8c
Compare
| @@ -250,19 +250,18 @@ See the [Acceptable Casks documentation](Acceptable-Casks.md#finding-a-home-for- | |||
|
|
|||
| Hop into your tap and check to make sure your new cask is there: | |||
|
|
|||
| ```bash | |||
| ```console | |||
There was a problem hiding this comment.
What is the advantage of using console here over bash or sh?
There was a problem hiding this comment.
This lexer distinguishes between what's typed at a prompt and its output (example).
docs/Tips-N'-Tricks.md
Outdated
| @@ -67,7 +67,7 @@ export HOMEBREW_INSTALL_BADGE="☕️ 🐸" | |||
|
|
|||
| ## Migrate a Homebrew installation to a new location | |||
|
|
|||
| Run `brew bundle dump` and `brew bundle install` record an installation to and install from a `Brewfile`. See `brew bundle --help` for more details. | |||
| Running `brew bundle dump` and `brew bundle install` will record an installation to and install from a `Brewfile`. See `brew bundle --help` for more details. | |||
There was a problem hiding this comment.
Running
brew bundle dumpwill record an installation in aBrewfilewhilebrew bundle installwill install from aBrewfile.
IMO this would be clearer by splitting things up more like this.
Library/Homebrew/dev-cmd/release.rb
Outdated
| @@ -11,13 +11,12 @@ def release_args | |||
| Homebrew::CLI::Parser.new do | |||
| description <<~EOS | |||
| Create a new draft Homebrew/brew release with the appropriate version number and release notes. | |||
| Requires write access to the Homebrew/brew repository. | |||
There was a problem hiding this comment.
Maybe it'd be better with Note: ....
| @@ -333,7 +333,7 @@ module EnvConfig | |||
| boolean: true, | |||
| }, | |||
| HOMEBREW_PIP_INDEX_URL: { | |||
| description: "If set, `brew install <formula>` will use this URL to download PyPI package resources.", | |||
| description: "If set, `brew install` <formula> will use this URL to download PyPI package resources.", | |||
There was a problem hiding this comment.
I think I prefer the old way more since it groups together the command with the arguments into one logical unit.
There was a problem hiding this comment.
It's a quirk of the fact that the docs need to be processed by both a Markdown processor for web pages and ronn for manpages. This format is required because the original results in brew install *formula* on the webpage, rather than brew install formula (with "formula" in italics to indicate it's a placeholder word within a suggested command).
Use to distinguish additional notes from initial explanation and usage info
EricFromCanada
force-pushed
the
docs-assorted-improvements
branch
from
5858a8c
to
c493b5e
Compare
brew depsexplaining the cases in which it'll be in runtime dependencies mode (xref The output ofbrew deps protobufis different frombrew deps protobuf --tree#13184)consolehighlighterHOMEBREW_API_WWWglobal and use it in the documentation