MetOffice / MetOffice/dagrunner

DOC: README.md further maintenance

Open
#22 0 comments 0 reactions 1 assignee View on GitHub

@cpelley is already working on this.

Since May 2, 2024.

documentation
Dominant language
Python
Stars
5
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Tasks

  • Migrate some of the documentation from README.md to relevant Python modules (module documentation).
  • Fluff out missing class/function/method/module docstrings.
  • Ensure all docstrings are rendered correctly as markdown.
  • Update call signature extract to accommodate non type defaults.

Issues

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.