Conversation
The README led with `brew install qeetgroup/tap/qeet`, which is uglier than it needs to be. After `brew tap qeetgroup/tap`, Homebrew resolves the bare name from that tap, so `brew install qeet` and `brew upgrade qeet` both work. The install instructions now lead with the two-step and mention the prefixed one-liner as an equivalent. The previous wording was also imprecise in a way that matters: it said `brew install qeet` "does not work yet", when in fact it works on any machine that has tapped -- which includes every machine that ever installed via the prefixed form, because that taps automatically. That is a trap when testing: the bare command appears to work locally while still failing on a fresh machine. docs/releasing.md now spells that out, since it is the kind of thing that leads to documenting a command that only works for the person who wrote the docs. What genuinely remains missing is homebrew-core, which needs the notability threshold and a from-source formula. Limitations says that, and also notes that the tap is not yet updated automatically on release -- so `brew upgrade` can lag a release until the publish job is enabled.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README led with
brew install qeetgroup/tap/qeet, which is uglier than necessary.What changed
brew tap qeetgroup/tap # once per machine brew install qeetAfter that one-time tap, Homebrew resolves the bare name from it, so
brew install qeetandbrew upgrade qeetboth work. The prefixed form is still mentioned as an equivalentone-liner.
The imprecision that mattered
The old wording said
brew install qeet"does not work yet". That was wrong in a wayworth calling out: it works on any machine that has tapped — which includes every machine that
ever installed via the prefixed form, because that taps automatically.
So the bare command appears to work when you test it locally while still failing on a fresh
machine. Verified here:
qeetgroup/tapis inbrew tap,qeetreturns HTTP 404 fromhomebrew-core, and
brew info qeetresolvesFrom: qeetgroup/homebrew-tap.docs/releasing.mdnow spells that trap out, because it is exactly how a command that onlyworks for the author ends up in documentation.
What is genuinely still missing
brew install qeet— needs the notability thresholdand a from-source formula.
brew upgrade qeetsilently lags a release until the formula is pushed by hand. It neededdoing manually to get this machine from 0.1.1 to 0.2.1.