-
-
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
Update modules.rst #8587
Update modules.rst #8587
Conversation
Hello, reading the Julia modules documentation I found it a bit misleading IMHO. So I updated the summary table in a way that is showing that in any case, it is possible to overload the module functions when whole module or any of its function is brought into the current scope using "using" or "import" statements. Instead what changes is the cases "exports" are brought into scope or not and when it is possible to overload it or not. I am not a Julia export so please let me know if I am mistaken.
I see your point, but i worry this patch makes the table harder to read because every cell would contain |
Yes I agree, I had the same thought actually and I was thinking that maybe we could remove these "MyModule.x, MyModule.y, MyModule.p" and add a short notice after the table like: Note: In all cases, |
Maybe we could write |
While the attention is on this table: it took me time to even notice that there is a third colum in this table (in the online docs): if I notice the scroll bar at all, it seems to me that it would only help to see one last variable in the first row and I won't bother to scroll. It's very boring to have to scroll when the webpage could already show everything. Could readthedocs be adjusted? |
There is an update of the documentation inspired from what was suggested in the above discussion. |
fixed typo
fixed typo
+------------------------------------+-------------------------------------+---------------------------------------------------+ | ||
| ``import MyModule`` | ``MyModule.*`` | ``MyModule.*`` | | ||
+------------------------------------+-------------------------------------+---------------------------------------------------+ | ||
| ``import MyModule.x, MyModule.p`` | ``x``, ``p``, ``MyModule.*`` | ``x``, ``p``, ``MyModule.*`` | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is incorrect. import MyModule.x
only makes x
visible, not MyModule
.
Please revert. |
Ugh, sorry. Clicked the wrong button. |
@JeffBezanson please correct me if I am wrong but here is what I did: I created a file |
@dletozeun, this is an (unfortunate) artifact of the fact that at the REPL, you are in the |
@StefanKarpinski Oh I see, thank you for the clarification! |
Hello,
reading the Julia modules documentation I found the summary table a bit misleading IMHO.
So I updated the summary table in a way that is showing that in any case, it is possible to overload the module functions when whole module or any of its function is brought into the current scope using "using" or "import" statements. Instead what changes is the cases "exports" are brought into scope or not and when it is possible to overload it or not.
I am not a Julia expert so please let me know if I am mistaken.