NCAS-CMS / NCAS-CMS/cf-plot

Ensure all unnumbered docs examples are image-comp. tested

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

@sadielbartholomew is already working on this.

Since Jan 20, 2025.

docs image-based testing
Dominant language
Python
Stars
21
Forks
11
Avg merge
7h 11m
Merged PRs (30d)
1

Description

First connected items of follow-on work from PR #81 (lifted from my opening comment):

  • check for unnumbered examples across the docs and add all of these to the test suite, then ensure they work and coordinate so the precise working versions are documented;
  • add reference plots to compare with, the uncomment the @compare_plot_results decorators.

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.