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.

Sign up for GitHub

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

Jump to bottom

Generate new doctest output automatically #158

Closed
AshlinHarris opened this issue Aug 9, 2022 · 2 comments
Closed

Generate new doctest output automatically #158

AshlinHarris opened this issue Aug 9, 2022 · 2 comments
Assignees
@AshlinHarris

Comments

@AshlinHarris
Copy link
Contributor

Documenter.jl includes a fix=true option for fixing outdated doctests. I believe this would allow a developer to automatically generate the output for a new doctest without needing to ]develop the package, test the function, and manually copy the output into the source. I'd like to add a toggle for this.

https://juliadocs.github.io/Documenter.jl/stable/man/doctests/#Fixing-Outdated-Doctests
@AshlinHarris AshlinHarris self-assigned this Aug 9, 2022
@AshlinHarris AshlinHarris linked a pull request Aug 9, 2022 that will close this issue
Add fix=false to doctest() #161
Merged
@AshlinHarris AshlinHarris reopened this Aug 15, 2022
@AshlinHarris
Copy link
Contributor Author

The option fix=true should be passed to doctest(), not makedocs().

JuliaDocs/Documenter.jl#1901

@AshlinHarris AshlinHarris removed a link to a pull request Aug 15, 2022
Add fix=false to doctest() #161
Merged
@AshlinHarris AshlinHarris linked a pull request Aug 16, 2022 that will close this issue
Fix doctest output automatically #184
Closed
@AshlinHarris AshlinHarris removed a link to a pull request Aug 18, 2022
Fix doctest output automatically #184
Closed
@AshlinHarris AshlinHarris mentioned this issue Aug 18, 2022
Merged
@AshlinHarris
Copy link
Contributor Author

#188

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

@AshlinHarris AshlinHarris

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@AshlinHarris