doc: cover environment variable support #1901
Merged
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
Guidance also applies to accessing config attributes *as attributes*, so it's not a bad idea to have anyway. Also added explicit directions for the highly unlikely case where two plugins somehow manage to define two differently named config sections which, when combined with certain keys, collide when converted to the `env_name` format. Again, *highly* unlikely. But putting the naming guidance in also lays the foundation for (possibly) adding dot-delimited envvar name support (on platforms where they work) in a future release.
Exirel
approved these changes
Jun 28, 2020
Contributor
Exirel
left a comment
Exirel
left a comment
There was a problem hiding this comment.
Looks good. Just one suggestion, but I'm not sure if it makes sense or not. I leave that to you.
dgw
commented
Jun 28, 2020
Why is this so hard to put in words concisely?
Member
Author
|
Totally forgot to come back to this after merging #1900 the other day. 😅 |
Exirel
approved these changes
Jul 6, 2020
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.
Description
We had a couple spots in the documentation that mentioned the
SOPEL_CONFIGvar in passing, but no real documentation about it or the ability to override individual settings with envvars.Now we'll have a whole section (in the CLI chapter) about all supported environment variables.
This is forked off of #1900's WIP branch, so the first commit can be ignored for now. (GitHub may hide it from this PR once #1900 is merged, if its smarts hold up.)
Checklist
make qa(runsmake qualityandmake test)