mapbox / mapbox/nodata

pydocstyle reports 18 missing docstrings (D1xx)

Open
#71 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
1
Forks
2
PR merge metrics
No merged PRs in 30d

Description

```
$ pydocstyle nodata --select=D1 | grep -c D10
18
```

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Run `pydocstyle nodata --select=D1` and inspect the reported D1xx locations in the `nodata` package. Add the missing docstrings, then rerun the command and confirm that the D10 count is zero.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.