Skip to content

docs/src/index.md still opens with the example the registration review said does not run #19

Description

@sotashimozono

The front page opens with:

@experimental "convergence not established below β ≈ 0.1" energy(m::Model) = m.β * correction(m)

Model and correction are defined nowhere. Measured: UndefVarError: Model not defined.

This is the defect the registration review named for the README. It was corrected there (#11) and not here — one file over, where a reader arriving at the documentation site meets it first.

Fix

Make the example self-contained, and make it a @example block so Documenter runs it during the docs build rather than leaving it inert:

┌ Error: failed to run `@example` block in docs/src/index.md:14-20
│    UndefVarError: `Model` not defined in `Main.__atexample__named__frontpage`

That is the guard the review suggested, applied to the block that needs it most.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions