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

Jump to bottom

Docs: Reference functions instead of methods #38986

Merged
merged 3 commits into from
Apr 3, 2021
Merged

Docs: Reference functions instead of methods #38986

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
357e28e
Reference functions instead of methods
BioTurboNick Dec 24, 2020
b801d32
Update collections.md
BioTurboNick Dec 28, 2020
436a9d3
Narrowing scope
BioTurboNick Feb 22, 2021
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
Next Next commit
Reference functions instead of methods 
By referencing methods sometimes and not just functions, there was some duplication and confusion. For instance, we had `get(::Any, ::Any, ::Any)` method and also a `get` function, the latter of which duplicated the documentation for the former.

Is there an unseen benefit to referencing just the function at times?

If this PR is acceptable, I can go through the other pages to do the same.
  • Loading branch information
@BioTurboNick
BioTurboNick committed Dec 24, 2020
commit 357e28e794bf8f2801ac4bbf2c979a8eb8e3b826
32 changes: 12 additions & 20 deletions doc/src/base/collections.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@ Base.indexin
Base.unique
Base.unique!
Base.allunique
Base.reduce(::Any, ::Any)
Base.foldl(::Any, ::Any)
Base.foldr(::Any, ::Any)
Base.reduce
Base.foldl
Base.foldr
Base.maximum
Base.maximum!
Base.minimum
Expand All @@ -111,32 +111,26 @@ Base.sum
Base.sum!
Base.prod
Base.prod!
Base.any(::Any)
Base.any(::AbstractArray, ::Any)
Base.any
Base.any!
Base.all(::Any)
Base.all(::AbstractArray, ::Any)
Base.all
Base.all!
Base.count
Base.any(::Any, ::Any)
Base.all(::Any, ::Any)
Base.foreach
Base.map
Base.map!
Base.mapreduce(::Any, ::Any, ::Any)
Base.mapfoldl(::Any, ::Any, ::Any)
Base.mapfoldr(::Any, ::Any, ::Any)
Base.mapreduce
Base.mapfoldl
Base.mapfoldr
Base.first
Base.last
Base.front
Base.tail
Base.step
Base.collect(::Any)
Base.collect(::Type, ::Any)
Base.collect
Base.filter
Base.filter!
Base.replace(::Any, ::Pair...)
Base.replace(::Base.Callable, ::Any)
Base.replace
Base.replace!
Base.rest
```
Expand Down Expand Up @@ -200,13 +194,11 @@ Base.IdDict
Base.WeakKeyDict
Base.ImmutableDict
Base.haskey
Base.get(::Any, ::Any, ::Any)
Base.get
Base.get!(::Any, ::Any, ::Any)
Base.get!(::Function, ::Any, ::Any)
Base.get!
Base.getkey
Base.delete!
Base.pop!(::Any, ::Any, ::Any)
Base.pop!
Base.keys
Base.values
Base.pairs
Expand Down