Write and require docstrings for public module functions
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- cli, documentation
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.
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
- Dominant language
- Python
- Stars
- 141
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from mapbox/tilesets-cli
-
Difficulty 4/5 3-5 days Newbie friendliness 28/100
mapbox/tilesets-cli#217 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
mapbox/tilesets-cli#216 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 25/100
mapbox/tilesets-cli#193 · 1 comment ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
mapbox/tilesets-cli#190 · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
mapbox/tilesets-cli#171 · 1 reaction ·
All issues in mapbox/tilesets-cli
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
NousResearch/hermes-plugin-claude-subscription-directsdk#94 ·
Maintainers usually reply within 1 day
-
namespace operations
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
EclipseFdn/open-vsx.org#13702 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
modelscope/ms-swift#10287 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
modelscope/FunASR#3757 ·
Maintainers usually reply within 1 day