Docstrings for the remaining packages, then turn the rule on

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

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
testing, tooling

Research direction

Read CONTRIBUTING.md and inspect the remaining public APIs in config.py, adapters/, importers/, store/, gate/, suites/ and snapshots/ to identify the missing docstrings. Then update the select list in pyproject.toml to enable pydocstyle D1 rules and run the project’s Ruff checks. Done when Ruff enforces public API docstrings in CI.

Written by the indexing model from the issue text.

Description

documentation good first issue size: S
Context

After the runtime, models, grading and manifest issues, about 35 items remain in config.py, adapters/, importers/, store/, gate/, suites/ and snapshots/.

What to do

Add them, then enable the pydocstyle D1 rules in pyproject.toml so new code keeps docstrings.

Done when

ruff enforces docstrings on public APIs in CI.

Where to look

pyproject.toml ([tool.ruff.lint] select)


New here? Read CONTRIBUTING.md and comment on this issue to say you are taking it.


Generated by Claude Code

Dominant language
Python
Stars
0
Forks
0
Avg merge
1h 54m
Merged PRs (30d)
14

Getting set up

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.

More from patsypppe/meridian

All issues in patsypppe/meridian

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.