CliMA / CliMA/ClimaAnalysis.jl

Use @repl and @example to evaluate code rather than hardcoding results

Open
#236 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Julia
Stars
12
Forks
5
Avg merge
7d 2h
Merged PRs (30d)
2

Description

Instead of hardcoding the results, the documentation should use `@repl` and `@example` from Documenter.jl to evaluate the results.

Contributor guide

No contributing guide indexed for this repository

Research direction

No documentation files or tests are named. First inspect the repository's documentation sources and Documenter.jl usage to find hardcoded results, then replace the relevant examples with @repl or @example blocks and verify that the documentation build evaluates them correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.