Docs: Reference functions instead of methods #38986
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
BioTurboNick
changed the title
fredrikekre
requested changes
Dec 28, 2020
|
I think I made the only necessary change. |
|
@fredrikekre Is this ok to merge? |
|
I narrowed the scope to just change it for |
ElOceanografo
pushed a commit
to ElOceanografo/julia
that referenced
this pull request
May 4, 2021
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 on the same page.
antoine-levitt
pushed a commit
to antoine-levitt/julia
that referenced
this pull request
May 9, 2021
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 on the same page.
johanmon
pushed a commit
to johanmon/julia
that referenced
this pull request
Jul 5, 2021
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 on the same page.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 agetfunction, the latter of which duplicated the documentation for the former.Is there an unseen benefit to referencing just the function at times?EDIT: Documenter errors if there are exact duplicates, and sometimes it makes sense to split the functions by section.If this PR is acceptable, I can go through the other pages to do the same.