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

Change docstring script examples to REPL examples #178

Merged
merged 8 commits into from
Aug 12, 2022
Merged

Change docstring script examples to REPL examples #178

merged 8 commits into from
Aug 12, 2022

Conversation

AshlinHarris
Copy link
Contributor

No description provided.

@AshlinHarris AshlinHarris linked an issue Aug 12, 2022 that may be closed by this pull request
Change script examples to REPL examples #176
Closed
@AshlinHarris
Copy link
Contributor Author

Two potential issues:

  1. Documenter.jl might not recognize fix=true anymore (doctest(...; fix=true) not working JuliaDocs/Documenter.jl#1782).
  2. I think Documenter.jl expects a blank line between REPL commands. Otherwise, it seems to skip commands.

@AshlinHarris AshlinHarris merged commit 9295896 into main Aug 12, 2022
@AshlinHarris AshlinHarris deleted the 176-change-script-examples-to-repl-examples branch August 12, 2022 18:32
@AshlinHarris AshlinHarris mentioned this pull request Aug 12, 2022
Closed
@AshlinHarris
Copy link
Contributor Author

One issue resolved: I needed to pass fix=true to doctest(), not makedocs().

JuliaDocs/Documenter.jl#1901

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Change script examples to REPL examples
1 participant
@AshlinHarris