-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
RFC: Add description to load a local module and using it in example codes. #41398
Conversation
Would you be willing to change these to doctests? This should show how to do it: https://juliadocs.github.io/Documenter.jl/stable/man/doctests/#Preserving-Definitions-Between-Blocks which mostly just means changing in the necessary places
to
|
Let's rebase this to master, and hope that the whitespace check runs through. Anything else we need here? |
I rebased. |
Whitespace check is failing |
Thank you. The remaining CI failures look unrelated. |
Is this good to merge? |
For me, yes. |
…odes. (JuliaLang#41398) * Add description to load a local module and using it in example codes. * make example codes to doctests. Co-authored-by: Viral B. Shah <[email protected]>
…odes. (JuliaLang#41398) * Add description to load a local module and using it in example codes. * make example codes to doctests. Co-authored-by: Viral B. Shah <[email protected]>
…odes. (JuliaLang#41398) * Add description to load a local module and using it in example codes. * make example codes to doctests. Co-authored-by: Viral B. Shah <[email protected]>
I think current Modules doc does not explain how to load a local module and some example codes do not work correctly reported in #40384, because the some example codes do not use local module loading syntax (missing a dot before the module name).
So, I added a description to load a local module and using it in example codes to fix #29302 and to fix #40384.