Improve restyled.yaml.5 #287
Merged
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
pbrisbin
commented
Nov 4, 2024
Comment on lines
+24
to
+28
| main = do | ||
| getArgs >>= \case | ||
| ["__render-docs-man1__"] -> renderDocsPage Restyle1 | ||
| ["__render-docs-man5__"] -> renderDocsPage RestyledYaml5 | ||
| _ -> pure () |
There was a problem hiding this comment.
Moving this here is better, and idiomatic according to ronn documentation.
| , env "DRY_RUN" | ||
| , conf "dry_run" | ||
| ] | ||
| withDefault False |
There was a problem hiding this comment.
Using withDefault is needed for yesNoSwitch. Defaults added with value don't show up in docs.
Comment on lines
+101
to
+102
| withShownByDefault :: (a -> String) -> a -> Parser a -> Parser a | ||
| withShownByDefault f a = withShownDefault a (f a) |
There was a problem hiding this comment.
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.
The goal here is to retire any existing configuration docs (which are already out of sync) and instead link to the generated man-page that is automatically maintained with the help of opt-env-conf and ronn libraries.
To do this, we:
default.yaml, put defaults into the settings buildershelpandexampleto approximate current docsronn-opt-env-conf+ bespoke template building to generate a readablerestyled.yaml.5As of this PR we're pretty close, we're only missing the
restylersdocumentation and examples, since that's a lot of important text, I'd like to work on it separately after.