Add examples for flags in README #520
Open
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
I couldn't find any documentation of flags and I ended up looking at the code. It wasn't clear to me from the current docs: 1. what was the top-level object name 2. wether individual flags had to be specified as objects or a list
|
@sol Can we please merge this? I was exactly looking for such an example snippet in the readme just now. |
mpilgrem
reviewed
Jun 16, 2024
There was a problem hiding this comment.
If an example would be helpful to remove that perceived ambiguity, would it not be better to add it to line 151, so that line is something like (given the limitations of tables in Markdown):
| `flags` | `flag <name>` | | Map from flag name to flag (see [Flags](#flags)) | `flags: { my-cabal-flag: { description: 'Optional description', manual: true, default: false } }` | || ``` | ||
| flags: | ||
| development: | ||
| description: A development or production build |
There was a problem hiding this comment.
The CI is complaining about trailing white space.
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.
I couldn't find any documentation of flags and I ended up looking at the code. It wasn't clear to me from the current docs:
hpack? Notest/EndToEndSpec.hs? Not applicable