Skip to content

parser: show related environment variable in switch description #20044

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.

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

Merged
merged 1 commit into from
Jun 4, 2025

Conversation

EricFromCanada
Copy link
Member

  • 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 style with your changes locally?
  • Have you successfully run brew typecheck with your changes locally?
  • Have you successfully run brew tests with your changes locally?

This replaces the need to include "Implied if $VAR is set" in switch descriptions by detecting and inserting it automatically. For brevity, skips doing so for --debug, --quiet, --verbose, --help by checking @non_global_processed_options, which is empty when global options are processed. Includes a provision for mentioning an additional related flag, as used by brew bundle's --cleanup. This also:

@EricFromCanada EricFromCanada added the documentation Documentation changes label Jun 3, 2025
@EricFromCanada EricFromCanada force-pushed the show-env-var-associations branch from 13a4224 to 3dc9e88 Compare June 3, 2025 17:58
Copy link
Member

@Rylan12 Rylan12 left a comment

Choose a reason for hiding this comment

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

Looks good!

@EricFromCanada EricFromCanada added this pull request to the merge queue Jun 4, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jun 4, 2025
@EricFromCanada EricFromCanada added this pull request to the merge queue Jun 4, 2025
Merged via the queue into master with commit ab1c3ed Jun 4, 2025
36 checks passed
@EricFromCanada EricFromCanada deleted the show-env-var-associations branch June 4, 2025 01:22
Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

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

Great work as usual @EricFromCanada, love this idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants