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

Mention require's case-sensitivity in documentation #17249

Merged
merged 2 commits into from
Jul 3, 2016

Conversation

sivapvarma
Copy link
Contributor

fixes #13579

@@ -1489,7 +1489,7 @@ 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 Windows.
Copy link
Member

Choose a reason for hiding this comment

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

"Mac OS"

Copy link
Member

Choose a reason for hiding this comment

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

Apple renamed it to macOS officially.

Copy link
Member

@nalimilan nalimilan Jul 2, 2016

Choose a reason for hiding this comment

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

Also, I don't think Windows is case-insensitive, is it?

EDIT: I see it's complicated, the filesystem is case-sensitive but the OS generally isn't.

Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Member

Choose a reason for hiding this comment

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

Apple renamed it to macOS officially.

OK, my bad.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

NTFS is case-sensitive! I did not know that.

From Wikipedia

Current Windows file systems, like NTFS, are case-sensitive; that is a readme.txt and a Readme.txt can exist in the same directory. However, the API for file access in Windows applications is case-insensitive, which makes filenames case-insensitive from the application's point of view.

I am not sure whether I should keep windows.

Copy link
Member

Choose a reason for hiding this comment

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

IIUC, NTFS can be case-sensitive, but Windows doesn't use that feature, so it's good idea to keep it.

Copy link
Contributor

Choose a reason for hiding this comment

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

You can change a setting to make your filesystem case sensitive, and Cygwin can use things that way, but Win32 generally doesn't differentiate.

Please wrap docstring lines.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

wrapped lines now.

@kshyatt kshyatt added the docs This change adds or pertains to documentation label Jul 3, 2016
@kshyatt kshyatt changed the title Mention require's case-sensitivity in documenation Mention require's case-sensitivity in documentation Jul 3, 2016
@kshyatt kshyatt merged commit 9a66205 into JuliaLang:master Jul 3, 2016
tkelman added a commit that referenced this pull request Jul 4, 2016
@@ -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".

mfasi pushed a commit to mfasi/julia that referenced this pull request Sep 5, 2016
Mention require's case-sensitivity in documentation
mfasi pushed a commit to mfasi/julia that referenced this pull request Sep 5, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs This change adds or pertains to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for require() should be updated
7 participants