Add glossary and disambiguate cabal vs Cabal #10631
Draft
Conversation
This file contains 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
geekosaur
reviewed
Dec 10, 2024
| @@ -92,7 +92,7 @@ You *must* provide a non-empty list of local packages in your project, filling | |||
| out either a ``packages`` field or an ``optional-packages`` field or both to | |||
| satisfy this requirement. | |||
|
|
|||
| When ``cabal.project`` doesn't exist, ``cabal-install`` fabricates an ephemeral | |||
| When ``cabal.project`` doesn't exist, :term:`cabal-install:exe:cabal` fabricates an ephemeral | |||
There was a problem hiding this comment.
In other places, cabal-install describes the package and cabal the command.
| @@ -315,7 +315,7 @@ package, and thus apply globally: | |||
|
|
|||
| :default: 1 | |||
|
|
|||
| Control the verbosity of ``cabal`` commands, valid values are from 0 | |||
| Control the verbosity of :term:`cabal` commands, valid values are from 0 | |||
There was a problem hiding this comment.
…this line being an example
|
|
||
| If you execute ``cabal <cmd>``, ``cabal-install`` will search the path for an executable named ``cabal-<cmd>`` and execute it. The name of the command is passed as the first argument and | ||
| If you execute ``cabal <cmd>``, :term:`cabal-install:exe:cabal` will search the path for an executable named ``cabal-<cmd>`` and execute it. The name of the command is passed as the first argument and |
There was a problem hiding this comment.
Mmm, and here's a third one for the same thing. Consistency would be nice.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #9976, by referring to glossary terms.
Warning
Very much a draft but review comments are welcome. Am I on the right track with this?