Clarify documentation
Open
Beginner friendly
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
The sample and README have inconsistent names for the config file. Make them match what the program actually defaults to.
Also, clarify what is meant by the working directory, for the sake of new Python users.
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
Read the program's default config filename first, then compare the config-file names in the README and sample. Clarify the working directory explanation for new Python users, and consider the work done when both documents match the program's default and define the term 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
- 62/100