Skip to content

Comments

docs: update example commands syntax of "brew help"#21625

Closed
egypcio wants to merge 2 commits intoHomebrew:mainfrom
egypcio:docs-update-help-troublesooting-example
Closed

docs: update example commands syntax of "brew help"#21625
egypcio wants to merge 2 commits intoHomebrew:mainfrom
egypcio:docs-update-help-troublesooting-example

Conversation

@egypcio
Copy link

@egypcio egypcio commented Feb 25, 2026

by merging this change, we:

  • make brew help consistent when listing example commands;
  • update the "example usage" and "troubleshooting" sections so far.

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew lgtm (style, typechecking and tests) with your changes locally?

  • AI was used to generate or assist with generating this PR. Please specify below how you used AI to help you, and what steps you have taken to manually verify the changes.

  * make it consistent to other example command lines;

Signed-off-by: vinícius <651124+egypcio@users.noreply.github.com>
Copy link
Member

@bevanjkay bevanjkay Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the change below is being made, the others may as well be updated to be consistent too.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, that was indeed a nice catch! 😅
thanks!!1 patching right away...

Copy link
Author

@egypcio egypcio Feb 25, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

6012334

also changed the title of this PR accordingly 👍

dito, for the PR's description. commit logs were already clear

  * make it consistent to other example command lines;

Signed-off-by: vinícius <651124+egypcio@users.noreply.github.com>
@egypcio egypcio changed the title docs: update 'troubleshooting' section of "brew help" docs: update example commands syntax of "brew help" Feb 25, 2026
@MikeMcQuaid
Copy link
Member

This change is not correct. The existing syntax means "these are required arguments".

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants