MetOffice / MetOffice/ANTS

Review and refine ancil_2anc documentation

Open
#69 0 comments 0 reactions 0 assignees View on GitHub
📚 documentation
Dominant language
Python
Stars
7
Forks
10
Avg merge
1d 19h
Merged PRs (30d)
5

Description

📚 Documentation Request

At present, understanding the capabilities of `ancil_2anc` requires going to multiple sources of information. We should review and refine both the docstrings and help so that it is standalone and not in need of supplemental materials/documentation.

Contributor guide

Open the contributing guide

Research direction

Start by locating the ancil_2anc entry point and reviewing its current docstrings and help output. Compare the information available there with any supplemental documentation currently needed. Done means the capabilities and usage are understandable from the docstrings and help alone.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.