MetOffice / MetOffice/fab

Add doctest

Open
#361 2 comments 0 reactions 0 assignees View on GitHub
enhancement Requires investigation
Dominant language
Python
Stars
9
Forks
9
Avg merge
12d 12h
Merged PRs (30d)
2

Description

To make sure that examples in the documentation actually work, we need to add support for doctest in the doc directory.

Contributor guide

Open the contributing guide

Research direction

Start by locating how the doc directory is built and where documentation examples are collected or checked. Determine how doctest should run against those examples, then verify that the documentation examples execute successfully as part of the documentation workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.