Document PyYAML requirement more prominently
Open
Beginner friendly
Nobody has claimed this yet.
help wanted
- Dominant language
- JavaScript
- Stars
- 2.8k
- Forks
- 564
- Avg merge
- 3d 7h
- Merged PRs (30d)
- 10
Description
Preferably near where the instructions are to run python make.py and/or in the make.py and script itself (other than the import line).
Python's error message did not make it particularly obvious that a required package was missing.
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 by locating the instructions for running python make.py, then inspect make.py and the script itself around the PyYAML import. Document the required package near the command or in the script without relying on the import error; done means a user can identify the missing dependency before running the tool.
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
- 68/100