docs: explain env prefixing for nested structs#46
Merged
Conversation
Clarify that a parent struct field name is automatically prepended as a prefix to nested keys, so nested env tags should use only the leaf name. Documents the S3_S3_ENDPOINT gotcha and how to override or omit the prefix. Closes #38.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
envtags should contain only their leaf name (e.g.env:"ENDPOINT"→S3_ENDPOINT).S3_S3_ENDPOINTgotcha from the issue, plus how to override the prefix via anenvtag on the parent field and how to drop it withomitprefix.Behavior was verified against
load/env/env.go; this is a docs-only change since the existing behavior is intentional and just wasn't documented.Closes #38.
Test plan