Update environment var table to have descriptions instead of pairs #692
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
The previous iteration of this table mapped the environment variables to the CLU flags: this one instead replicates the descriptions from the flags, ensuring a user doesn't need to cross-reference them. It also changes the table to an include, meaning it can be easily updated and re-used from a single source in the future if necessary.
github-actions
bot
added
the
documentation
✅ Deploy Preview for agent-public-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
dhurley
reviewed
May 28, 2024
I accidentally removed them during merge conflict resolution: they also needed to be moved to the top for the sake of matching the flags, which are alphabetized.
dhurley
approved these changes
May 29, 2024
travisamartin
requested changes
Jun 11, 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.
Proposed changes
The previous iteration of this table mapped the environment variables to the CLU flags: this one instead replicates the descriptions from the flags, ensuring a user doesn't need to cross-reference them.
It also changes the table to an include, meaning it can be easily updated and re-used from a single source in the future if necessary.
Checklist
Before creating a PR, run through this checklist and mark each as complete.
CONTRIBUTINGdocumentmake install-toolsand have attached any dependency changes to this pull requestREADME.md)