Render environment variables and actual CLI/fmf examples of plugin keys #3580
+84
−9
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
happz
requested review from
psss,
lukaszachy,
thrix,
janhavlin and
martinhoyer
as code owners
|
|
happz
force-pushed
the
sphinx-docs-render-envvars-and-examples
branch
2 times, most recently
from
b90c829 to
de58125
Compare
|
/packit build |
Improves documentation by showin examples of keys with actual values. This should help readers of HTML docs, but eventually, when ReST rendering gets improved, it would end up in CLI help too.
happz
force-pushed
the
sphinx-docs-render-envvars-and-examples
branch
from
de58125 to
8a13199
Compare
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.
Improves documentation by showind examples of keys with actual values. This should help readers of HTML docs, but eventually, when ReST rendering gets improved, it would end up in CLI help too.
Kudos to @jscotka for the idea.
Pull Request Checklist