MetOffice / MetOffice/CSET

Include some of the docstring information in the output webpage

Open
#414 1 comment 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Python
Stars
33
Forks
19
Avg merge
1d 22h
Merged PRs (30d)
30

Description

In many recipes, such at [the CAPE ratio](https://metoffice.github.io/CSET/reference/operators.html#CSET.operators.convection.cape_ratio) there is a substantial amount of useful scientific information in the Notes section of the docstring. This is not exposed in the output webpage currently, where it would be really useful.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the generated CAPE ratio reference page linked in the issue and compare its output with the recipe docstring's Notes section. Trace how docstrings become the output webpage, then expose the relevant Notes content and verify that the rendered page includes it.

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.