From 778b0e1f8027657e5a5f6cfadcb277b54eefdbab Mon Sep 17 00:00:00 2001 From: Alexander Morley Date: Sun, 4 Dec 2016 17:52:07 +0000 Subject: [PATCH] Updated docstring for `Pkg.installed` to make it clear that it will only return if the `pkg` is registered. --- base/pkg/pkg.jl | 3 ++- doc/stdlib/pkg.rst | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/base/pkg/pkg.jl b/base/pkg/pkg.jl index 828a7d9bef50e..b359d6f45d958 100644 --- 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 index 348505145fbb7..f947a248793cd 100644 --- 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()