Updated docstring for Pkg.installed to make it clear that it will o…

…nly return if the `pkg` is registered.
JuliaLang · Dec 4, 2016 · 778b0e1 · 778b0e1
1 parent 8dd8ea9
commit 778b0e1
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/base/pkg/pkg.jl b/base/pkg/pkg.jl
@@ -124,7 +124,8 @@ installed() = cd(Entry.installed)
 """
     installed(pkg) -> Void | VersionNumber
 
-If `pkg` is installed, return the installed version number, otherwise return `nothing`.
+If `pkg` is installed, return the installed version number. If `pkg` is registered,
+but not installed, return `nothing`.
 """
 installed(pkg::AbstractString) = cd(Entry.installed,pkg)
 

diff --git a/doc/stdlib/pkg.rst b/doc/stdlib/pkg.rst
@@ -91,7 +91,7 @@ Functions for package development (e.g. ``tag``, ``publish``, etc.) have been mo
 
    .. Docstring generated from Julia source
 
-   If ``pkg`` is installed, return the installed version number, otherwise return ``nothing``\ .
+   If ``pkg`` is installed, return the installed version number. If ``pkg`` is registered, but not installed, return ``nothing``\ .
 
 .. function:: status()