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.

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

recommend explicit using Foo: Foo, ... in package code (was: "using considered harmful") #42080

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
9 changes: 9 additions & 0 deletions base/docs/basedocs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,15 @@ kw"help", kw"Julia", kw"julia", kw""
available for direct use. Names can also be used via dot syntax (e.g. `Foo.foo` to access
the name `foo`), whether they are `export`ed or not.
See the [manual section about modules](@ref modules) for details.

!!! note
Doing `using Foo` in packages or code that you want to keep working with
updated dependencies is not recommended. The reason for this is if another
dependency starts to export one of the same names as `Foo` the code will
error due to an ambiguity in which package the name should be taken from.
Instead, explicitly list what names you want to use from Foo, for example:
`using Foo: Foo, parsefile, readfile` to get access bring `Foo` and two
functions `parsefile` and `readfile` into scope.
IanButterworth marked this conversation as resolved.
Show resolved Hide resolved
mbauman marked this conversation as resolved.
Show resolved Hide resolved
mbauman marked this conversation as resolved.
Show resolved Hide resolved
"""
kw"using"

Expand Down