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 script examples to REPL examples #176

Closed
AshlinHarris opened this issue Aug 11, 2022 · 0 comments · Fixed by #178
Closed

Change script examples to REPL examples #176

AshlinHarris opened this issue Aug 11, 2022 · 0 comments · Fixed by #178
Assignees
@AshlinHarris
Labels
documentation Improvements or additions to documentation

Comments

@AshlinHarris
Copy link
Contributor

Script examples show all outputs at the end, but REPL examples show the results of each command. I believe REPL examples are better suited for docstring examples.

https://juliadocs.github.io/Documenter.jl/stable/man/doctests/#REPL-Examples

Fixing this issue would also address #153.
@AshlinHarris AshlinHarris added the documentation Improvements or additions to documentation label Aug 11, 2022
@AshlinHarris AshlinHarris mentioned this issue Aug 11, 2022
Closed
@AshlinHarris AshlinHarris self-assigned this Aug 12, 2022
@AshlinHarris AshlinHarris linked a pull request Aug 12, 2022 that will close this issue
Change docstring script examples to REPL examples #178
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AshlinHarris AshlinHarris

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Change docstring script examples to REPL examples bcbi/PreprocessMD.jl
1 participant
@AshlinHarris