[mkdocs] Improve descriptions
Open
Nobody has claimed this yet.
documentation
P2
- Dominant language
- Python
- Stars
- 18.8k
- Forks
- 2.8k
- Avg merge
- 16h 26m
- Merged PRs (30d)
- 21
Description
Looking at https://github.com/daexs/plotly.py/pull/80/files, some of the descriptions are very short and not informative.
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 reviewing the files and description changes shown in the referenced pull request. Identify the descriptions that are too short or uninformative, then update them so the affected documentation is clearer; done means the relevant descriptions provide useful context without unnecessary brevity.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100