Documentation unclear about non-existent configuration location
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 196
- PR merge metrics
- No merged PRs in 30d
Description
https://pypi.org/project/keyring/
It says:
> The configuration is stored in a file named “keyringrc.cfg” found in a platform-specific location. To determine where the config file is stored, run the following:
```
python -c "import keyring.util.platform_; print(keyring.util.platform_.config_root())"
```
So I run that and I get:
```
/home/teo/.local/share/python_keyring
```
however, there's no such path on my system.
So, either the method described for getting the config root is broken, or my installation is broken (meaning whatever code installed it is broken); or perhaps that's the location where the configuration file _can_ go if there's any, but you can have no configuration file (in which case all settings get a default value). If that is the case, then the docs should be more specific.
Contributor guide
No contributing guide indexed for this repository
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
Review the configuration guidance on the linked PyPI page and run the documented python command to compare the reported path with the user's observation. Confirm whether the path is merely the expected configuration location and whether the file is optional, then update the documentation to explain the behavior and defaults clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100