Merge pull request #18345 from JuliaLang/sjk/isdefined-doc

Fix docs for isdefined
JuliaLang · Sep 5, 2016 · 6bb08bf · 6bb08bf · nanosoldier · Sep 5, 2016
2 parents 4533900 + 00cb3f7
commit 6bb08bf
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 5 deletions.
diff --git a/base/docs/helpdb/Base.jl b/base/docs/helpdb/Base.jl
@@ -1679,12 +1679,17 @@ eta
 """
     isdefined([m::Module,] s::Symbol)
     isdefined(object, s::Symbol)
-    isdefined(a::AbstractArray, index::Int)
+    isdefined(object, index::Int)
+    isdefined(a::Array, index::Int)
 
 Tests whether an assignable location is defined. The arguments can be a module and a symbol,
-a composite object and field name (as a symbol), or an array and index. With a single
-symbol argument, tests whether a global variable with that name is defined in
+a composite object and field name (as a symbol) or index, or an `Array` and index.
+With a single symbol argument, tests whether a global variable with that name is defined in
 `current_module()`.
+
+Note: For `AbstractArray`s other than `Array`, `isdefined` tests whether the given field
+index is defined, not the given array index. To test whether an array index is defined, use
+[`isassigned`](:func:`isassigned`).
 """
 isdefined
 

diff --git a/doc/stdlib/base.rst b/doc/stdlib/base.rst
@@ -349,11 +349,14 @@ All Objects
 
 .. function:: isdefined([m::Module,] s::Symbol)
               isdefined(object, s::Symbol)
-              isdefined(a::AbstractArray, index::Int)
+              isdefined(object, index::Int)
+              isdefined(a::Array, index::Int)
 
    .. Docstring generated from Julia source
 
-   Tests whether an assignable location is defined. The arguments can be a module and a symbol, a composite object and field name (as a symbol), or an array and index. With a single symbol argument, tests whether a global variable with that name is defined in ``current_module()``\ .
+   Tests whether an assignable location is defined. The arguments can be a module and a symbol, a composite object and field name (as a symbol) or index, or an ``Array`` and index. With a single symbol argument, tests whether a global variable with that name is defined in ``current_module()``\ .
+
+   Note: For ``AbstractArray``\ s other than ``Array``\ , ``isdefined`` tests whether the given field index is defined, not the given array index. To test whether an array index is defined, use :func:`isassigned`\ .
 
 .. function:: convert(T, x)