Skip to content

Fix docs for isdefined #18345

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 5, 2016
Merged

Fix docs for isdefined #18345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions base/docs/helpdb/Base.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1675,12 +1675,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

Expand Down
7 changes: 5 additions & 2 deletions doc/stdlib/base.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down