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.

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

improve names docstring #3178

Merged
merged 2 commits into from
Sep 25, 2022
Merged
Changes from 1 commit
Commits
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
4 changes: 3 additions & 1 deletion src/abstractdataframe/abstractdataframe.jl
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,9 @@ Return a freshly allocated `Vector{String}` of names of columns contained in `df
If `cols` is passed then restrict returned column names to those matching the
selector (this is useful in particular with regular expressions, `Cols`, `Not`, and `Between`).
`cols` can be:
* any column selector ($COLUMNINDEX_STR; $MULTICOLUMNINDEX_STR)
* any column selector ($COLUMNINDEX_STR; $MULTICOLUMNINDEX_STR); these column
selectors are documented in [General rules](@ref) section of the [Indexing](@ref)
part of the DataFrames.jl documentation
bkamins marked this conversation as resolved.
Show resolved Hide resolved
* a `Type`, in which case names of columns whose `eltype` is a subtype of `T`
are returned
* a `Function` predicate taking the column name as a string and returning `true`
Expand Down