Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Formula-Cookbook: add std_npm_args #17881

Merged
merged 1 commit into from
Jul 30, 2024
Merged

Formula-Cookbook: add std_npm_args #17881

merged 1 commit into from
Jul 30, 2024

Conversation

p-linnane
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?

Adds the new std_npm_args to the Formula Cookbook.

@p-linnane p-linnane added the documentation Documentation changes label Jul 26, 2024
@p-linnane p-linnane force-pushed the npm-args-docs branch 2 times, most recently from 21da735 to 552e24c Compare July 26, 2024 20:17
@p-linnane
Copy link
Member Author

Style was failing unless I put require "language/node" in single quotes.

@p-linnane
Formula-Cookbook: add std_npm_args
b1eb6da 
Signed-off-by: Patrick Linnane <[email protected]>
MikeMcQuaid
MikeMcQuaid reviewed Jul 29, 2024
View reviewed changes
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.

I appreciate this critique should have probably landed in the prior PR but: my concern with documentation like this is it inevitably results in the docs and the code becoming out of sync. What would you think about adjusting the docs to link to the code instead?

@p-linnane
Copy link
Member Author

@MikeMcQuaid So remove the actual listed args, and just have a list of std_*_args that are links to the lines in the codebase?

@carlocab
Copy link
Member

carlocab commented Jul 30, 2024 •
edited
Loading

@MikeMcQuaid So remove the actual listed args, and just have a list of std_*_args that are links to the lines in the codebase?

Or the online documentation, e.g. https://rubydoc.brew.sh/Formula.html#std_configure_args-instance_method. Some of it sucks though (e.g. https://rubydoc.brew.sh/Formula.html#std_cmake_args-instance_method)

I'm also not opposed to ripping it all out and just referencing the std_*_args as something you should use in a formula.

carlocab
carlocab approved these changes Jul 30, 2024
View reviewed changes
Copy link
Member

@carlocab carlocab left a comment

Choose a reason for hiding this comment

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

I'm ok for feedback to be fixed in succeeding PRs.

@p-linnane p-linnane merged commit 5d21958 into master Jul 30, 2024
24 checks passed
@p-linnane p-linnane deleted the npm-args-docs branch July 30, 2024 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MikeMcQuaid MikeMcQuaid MikeMcQuaid left review comments

@branchvincent branchvincent branchvincent approved these changes

@carlocab carlocab carlocab approved these changes

Assignees
No one assigned
Labels
documentation Documentation changes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@p-linnane @carlocab @MikeMcQuaid @branchvincent