Switch docstrings to Google style
Open
Nobody has claimed this yet.
documentation
good first issue
hacktoberfest
help wanted
Priority-Low
- Dominant language
- Python
- Stars
- 385
- Forks
- 102
- Avg merge
- 4d 2h
- Merged PRs (30d)
- 9
Description
Pyresample has a mixed set of docstring styles (my fault I think). All docstrings should be switched to Google style docstrings to match satpy and hopefully other pytroll packages.
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 surveying the repository's Python docstrings and compare their conventions with the Google style used by satpy and other pytroll packages. Update the docstrings throughout the project so they consistently follow that style, then verify that no mixed-style docstrings remain.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100