dunder methods missing from readthedocs API
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 385
- Forks
- 102
- Avg merge
- 4d 2h
- Merged PRs (30d)
- 9
Description
The AreaDefinition methods support several special methods, for which documentation is missing on readthedocs. The most relevant ones for the user are __contains__, __eq__, and __getitem__.
I think there's a sphinx setting to control whether those are generated with API docs or not.
Problem description
Most users get their documentation from readthedocs. From the API documentation, one wouldn't it's possible (or should be) to check if a certain lat/lon is contained inside an area definition, despite this feature being potentially quite useful.
Versions of Python, package at hand and relevant dependencies
Current pyresample / online docs.
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
Start by locating the Sphinx or Read the Docs API configuration for AreaDefinition. Check how special methods such as contains, eq, and getitem are handled, then verify the generated online API documentation. Done means these user-relevant methods are documented for AreaDefinition.
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