Overhaul manual pages for the web #4675
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
- Examples block now moved to its own section - Refer to flags by their full names - Use backticks for delimiting command-line expressions - Use double quotes for literal values
- "Examples" section now renders with syntax highlighting and doesn't interpret curly braces as Liquid tags anymore - Flags are now listed with nicer formatting than just being rendered to a plain text block - Flags are now listed above the "Examples" section - The `--help` flag is no longer explicitly and repetitively being listed as an inherited flag under every command - Usage synopsis line is now rendered early in the documentation for a command - Every command that has subcommands now explicitly lists those subcommands in its documentation
vilmibm
approved these changes
Nov 3, 2021
|
On a whim after stumbling across it I took a crack at adding the code formatting before checking to see if any of the active PR's or issues addressed it. Was literally the first go I've ever written and it was prematurely superseded by a PR approved yesterday. |
|
@gileswells This happens to me all the time. I hope you had fun fixing the bug on your own and learning Go. Don't let this discourage you from contributing to our or any other project |
Closed
Merged
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.
Commands that have subcommands now list those subcommands in their docs:
Command flags are now rendered as a definition list in HTML rather than as plaintext table and they now appear above the "Examples" section:
"Examples" sections are now syntax-highlighted and exempt from processing Go template
{{ ... }}tags as if they were Liquid tags for Jekyll sites:Also:
--helpflag is no longer repetitively documented in every manual page as an inherited flaggh secretamong Actions commandsgh codespace cpdocsThe text was updated successfully, but these errors were encountered: