Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect description of separator usage in Environment::with_prefix() #539

Open
Zoufar opened this issue Feb 26, 2024 · 0 comments
Open

Comments

@Zoufar
Copy link

Zoufar commented Feb 26, 2024

Description of pub fn with_prefix(s: &str) reads following:
"A prefix with a separator of _ is tested to be present on each key before its considered to be part of the source environment."

In fact, proper formulation could be:
"A prefix with a separator set by pub fn prefix_separator() OR (if no prefix_separator set) set by pub fn separator() OR (if none of previous) of "_" is tested to be present on each key before its considered to be part of the source environment."

Also, there may be added following piece of text to the description of pub fn separator(mut self, s: &str):
"In case of prefix separator not being explicitly set by pub fn prefix_separator(), this character sequence will be used also as prefix separator."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant