AUGUR_DEBUG documentation
#1587
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
Among other things, this makes the var names linkable with
:envvar:`…`
and indexes them not just individually but also collectively under
"Environment variables" so the index includes a single list of all
documented vars.
When I originally wrote this page, I didn't yet know about the envvar
directive and role. I've since used it extensively in Nextstrain CLI's
documentation, though.
…instead of being buried in the developer API pages. Much more discoverable. Modifies formatting of the rST to match the new document's existing formatting, but the content is the same. Thanks to @joverlee521 for catching this misplacement in post-merge review.¹ ¹ <#1577 (comment)>
Includes clarification of "a truthy value" as "a non-empty value", since all env vars values are strings and any non-empty string is a truthy value in Python. The new phrasing matches existing phrasing in our docs and makes it much clearer to a reader not thinking about details of Python's values.
4 tasks
joverlee521
approved these changes
Aug 20, 2024
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.
See commit messages.
Related to #1577.
Checklist