Skip to content
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

document the return types of fieldname and fieldnames #55259

Merged
merged 3 commits into from
Aug 1, 2024
Merged

document the return types of fieldname and fieldnames #55259

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
67337cf
document the return types of `fieldname` and `fieldnames`
nsajko Jul 26, 2024
6cf3b9c
"it's" -> "it is"
nsajko Jul 30, 2024
233e4c8
common case first
nsajko Jul 30, 2024
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: 11 additions & 0 deletions base/reflection.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,13 +212,18 @@ end

Get the name of field `i` of a `DataType`.

The return type is `Symbol`, except when `x <: Tuple`, in which case the index of the field is returned, of type `Int`.

# Examples
```jldoctest
julia> fieldname(Rational, 1)
:num

julia> fieldname(Rational, 2)
:den

julia> fieldname(Tuple{String,Int}, 2)
2
```
"""
function fieldname(t::DataType, i::Integer)
Expand Down Expand Up @@ -246,6 +251,9 @@ fieldname(t::Type{<:Tuple}, i::Integer) =

Get a tuple with the names of the fields of a `DataType`.

Each name is a `Symbol`, except when `x <: Tuple`, in which case each name (actually the
index of the field) is an `Int`.

See also [`propertynames`](@ref), [`hasfield`](@ref).

# Examples
Expand All @@ -255,6 +263,9 @@ julia> fieldnames(Rational)

julia> fieldnames(typeof(1+im))
(:re, :im)

julia> fieldnames(Tuple{String,Int})
(1, 2)
```
"""
fieldnames(t::DataType) = (fieldcount(t); # error check to make sure type is specific enough
Expand Down