Incorrect description of separator usage in Environment::with_prefix()
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 3.2k
- Forks
- 265
- Avg merge
- 2h 42m
- Merged PRs (30d)
- 4
Description
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."
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the documentation for Environment::with_prefix() and separator(), including the related prefix_separator() behavior described in the issue. Update the wording to explain the precedence of the prefix separator and clarify when separator() is reused. Done means both method descriptions accurately reflect the documented behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100