Skip to content

Commit

Permalink
Correct description of Pkg.dir() return value
Browse files Browse the repository at this point in the history
  • Loading branch information
simonp0420 committed Apr 27, 2015
1 parent 9ec6ae1 commit d905d66
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/stdlib/pkg.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ to use them, you'll need to prefix each function call with an explicit ``Pkg.``,
.. function:: dir() -> AbstractString

Returns the absolute path of the package directory.
This defaults to ``joinpath(homedir(),".julia")`` on all platforms (i.e. ``~/.julia`` in UNIX shell syntax).
If the ``JULIA_PKGDIR`` environment variable is set, that path is used instead.
This defaults to ``joinpath(homedir(),".julia","v$(VERSION.major).$(VERSION.minor)")`` on all platforms
(i.e. ``~/.julia/v0.4`` in UNIX shell syntax). If the ``JULIA_PKGDIR`` environment variable is set, then
that path is used in the returned value as ``joinpath(ENV["JULIA_PKGDIR"],"v$(VERSION.major).$(VERSION.minor)")``.
If ``JULIA_PKGDIR`` is a relative path, it is interpreted relative to whatever the current working directory is.

.. function:: dir(names...) -> AbstractString
Expand Down

0 comments on commit d905d66

Please sign in to comment.