docs: add flag value format to default config file and markdown #590
Conversation
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
Help message contains value format, add it to config file. This changes format of config file to the following: # proxy [protocol://]host[:port] # # Upstream proxy to use. The supported protocols are: http, https, socks5. No # protocol specified will be treated as HTTP proxy. If the port number is not # specified, it is assumed to be 1080. The basic authentication username and # password can be specified in the host string e.g. user:pass@host:port. # Alternatively, you can use the -c, --credentials flag to specify the # credentials. If both are specified, the proxy flag takes precedence. #proxy:
Add format to header. Use extended markdown syntax heading-ids [1] to make the anchor be just the flag name. [1] https://www.markdownguide.org/extended-syntax/#heading-ids
This changes the flag doc structure adding bullet list containing: Environment variable, Value Format and Default value.
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.
No description provided.