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
Completion installations are shown as caveats #2110
Comments
I agree this is a weird place. @Homebrew/maintainers thoughts on a better place for these? |
I like Locations or Paths. I'd also be interested in implementing something that will help writing these as we use them fairly commonly in homebrew/science. |
👍 on this, although I wonder if we can do this somehow without adding another DSL method. |
Could add an optional argument to |
What I mean is that we probably don't want something like this in the formula DSL: def completions
# return a big string like caveats
end Since it's just another moving part that, like caveats, probably won't stay in sync with the actual formula. Augmenting I'm not too familiar with how we use install receipts, though, so feel free to ignore that if it's too hacky/out-of-line with the use case 🙂 |
Agreed. I do wonder, though, if renaming this section at this point is going to cause more confusion than it will remove, particularly considering the consistency of the long tail of Homebrew formulae that would need updated. |
I think probably the point, at least originally, of putting information about completions into caveats is that in general completions don't work unless you do, or have done, something that we don't do for you. |
Closing this just because I don't think we can really change this (admittedly awkward) wording at this point without causing confusion. |
I'm not a native english speaker, but to me completion installations do not sound like caveats.
If there was a separate section for them, the "actual" caveats from formulas would maybe stand out a little better.
The text was updated successfully, but these errors were encountered: