Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove double doctest run, add strict doctest #560

Closed
wants to merge 1 commit into from

Conversation

albheim
Copy link
Member

@albheim albheim commented Oct 14, 2021

A recently merged PR in Documenter.jl allows for setting strict checking on certain errors.

We currently ran doctest by itself first before running it when generating documentation, I think this means we would not need to.

Just testing this for now, might need to figure out which errors we should use.

@JuliaControlBot
Copy link

Something failed when generating plots. See the log at https://github.com/JuliaControl/ControlExamplePlots.jl/actions/runs/1342389273?check_suite_focus=true for more details.

@baggepinnen
Copy link
Member

This seems like a good idea, reducing CI time is always welcome :)

@baggepinnen baggepinnen marked this pull request as ready for review November 7, 2021 07:59
@@ -30,7 +30,13 @@ println("Making docs")
makedocs(modules=[ControlSystems],
format=Documenter.HTML(),
sitename="ControlSystems.jl",
#strict=true,
strict=[
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't know exactly which ones we want here, they are not well explained but the names are decently explanatory. See https://github.com/JuliaDocs/Documenter.jl/pull/1689/files#diff-2c620811ba00ffd5e7b818bdefbab47fe9d7e3e11d046e6fe18e5c01fdff3f0cR227

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the ones you have chosen seem appropriate. I guess :setup_block always leads to downstream failures if it fails in a meaningful way.

Me might want to check :cross_references?

@albheim albheim changed the base branch from master to doctestfix November 7, 2021 09:03
@JuliaControlBot
Copy link

Something failed when generating plots. See the log at https://github.com/JuliaControl/ControlExamplePlots.jl/actions/runs/1431106250?check_suite_focus=true for more details.

Base automatically changed from doctestfix to master November 7, 2021 10:21
@albheim albheim closed this Nov 7, 2021
@albheim albheim deleted the albheim/update_doctest2 branch November 7, 2021 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants