Docstrings for `grading` and `manifest`

Open Beginner friendly
  • Is something wrong?
#126 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Start by reading the public items in src/meridian/grading/ and src/meridian/manifest/, then run the Ruff command listed in the issue to identify missing docstrings. Add docstrings to the reported items and rerun that command; done means it reports no D101, D102, or D103 violations.

Written by the indexing model from the issue text.

Description

area: grading documentation good first issue size: S
Context

About 30 public items in src/meridian/grading/ and src/meridian/manifest/ have no docstring.

What to do

Add them.

Done when

uv run ruff check src/meridian/grading src/meridian/manifest --select D101,D102,D103 is clean.

Where to look

src/meridian/grading/, src/meridian/manifest/

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.