kellpossible / kellpossible/toml-env

Wrong default mentioned in documentation

Open
#2 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue help wanted
Dominant language
Rust
Stars
7
Forks
2
PR merge metrics
No merged PRs in 30d

Description

https://github.com/kellpossible/toml-env/blob/caa945e629899b8bacff17dc0c0681deec1d142f/src/lib.rs#L339-L340

The doc for the divider says the default value is DEFAULT_DOTENV_PATH, but the actual default value is DEFAULT_MAP_ENV_DIVIDER.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open src/lib.rs at lines 339-340 and compare the divider documentation with the actual default constant named in the issue. Update the documented default to DEFAULT_MAP_ENV_DIVIDER, then verify the documentation matches the implementation.

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
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.