Documentation in enhancements not linked to trollimage documentation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 335
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 10
Description
The documentation for the satpy.enhancments is not linked to the relevant documentation in trollimage, making it very difficult for users to understand the functionality of that code if they have no prior experience with trollimage.
https://satpy.readthedocs.io/en/latest/api/satpy.enhancements.html
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 with the Satpy enhancements API documentation at https://satpy.readthedocs.io/en/latest/api/satpy.enhancements.html and inspect how its functionality relates to Trollimage. Identify the relevant Trollimage documentation to link from the Satpy page. Done means users can follow the links to understand the enhancement functionality without prior Trollimage experience.
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
- 35/100