Write and require docstrings for public module functions
Open
Nobody has claimed this yet.
loe 2
sdk-cli
- Dominant language
- Python
- Stars
- 141
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
As part of https://github.com/mapbox/tilesets-cli/issues/42, we'll be moving core functionality to a python module. All public module functions should have a docstring reflecting the usage of said function.
Some initial ideas are:
- Use numpy style docstrings https://numpydoc.readthedocs.io/en/latest/format.html
- Have a linting test that verifies docstring existence
cc @Gerdie
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 issue #42 and identifying the core functionality being moved into a Python module. Enumerate its public functions and decide which docstring style and linting approach fit the project. Done means public module functions have usage-reflecting docstrings and a test or lint check verifies their presence.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100