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

Mention require's case-sensitivity in documentation #17249

Merged
merged 2 commits into from
Jul 3, 2016
Merged

Mention require's case-sensitivity in documentation #17249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a754bb
mention case-sensitivity
sivapvarma Jul 2, 2016
1fffc16
wrap lines
sivapvarma Jul 3, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion base/docs/helpdb/Base.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1489,7 +1489,9 @@ This function is typically used to load library code, and is implicitly called b
load packages.

When searching for files, `require` first looks for package code under `Pkg.dir()`, then tries
paths in the global array `LOAD_PATH`.
paths in the global array `LOAD_PATH`. `require` is case-sensitive on all
platforms including those with case-insensitive filesystems like macOS and
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need a comma before the word "including", and "MacOS" is capitalized.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"MacOS" is capitalized.

Not anymore....

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh wow, I just noticed Apple's latest rebranding as "macOS".

Windows.
"""
require

Expand Down
3 changes: 1 addition & 2 deletions doc/stdlib/base.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Getting Around

Loads a source files, in the context of the ``Main`` module, on every active node, searching standard locations for files. ``require`` is considered a top-level operation, so it sets the current ``include`` path but does not use it to search for files (see help for ``include``\ ). This function is typically used to load library code, and is implicitly called by ``using`` to load packages.

When searching for files, ``require`` first looks for package code under ``Pkg.dir()``\ , then tries paths in the global array ``LOAD_PATH``\ .
When searching for files, ``require`` first looks for package code under ``Pkg.dir()``\ , then tries paths in the global array ``LOAD_PATH``\ .``require`` is case-sensitive on all platforms including those with case-insensitive filesystems like macOS and Windows.

.. function:: Base.compilecache(module::String)

Expand Down Expand Up @@ -1427,4 +1427,3 @@ Internals
.. Docstring generated from Julia source

Compile the given function ``f`` for the argument tuple (of types) ``args``\ , but do not execute it.