Document special meaning of ... in overloads
#10772
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
TH3CHARLie
approved these changes
Jul 7, 2021
hauntsaninja
reviewed
Jul 7, 2021
There was a problem hiding this comment.
To my understanding, the value of the default value never matters. "Sometimes" and "best practice" are weaselly words here: when and why? I think I'd phrase this as:
The actual value for the default value of an argument doesn't affect the signature, only the presence or absence of a default value does. Therefore to reduce redundancy, you can elide the default value, replacing it with the
...placeholder. For example:
|
@hauntsaninja Good point, I'll rephrase the paragraph 👍 |
|
@hauntsaninja I worked on the phrasing, let me know what you think 🙂 |
|
Looks great! Thanks for improving the docs! |
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.
Description
This PR documents the special meaning of ellipses for default values in overloads. The only reference I could find to this behavior in non-code writing is this comment by @Michael0x2a.
If you think it's inaccurate that this is (or should be) a best practice I'll rephrase that sentence, but it's my impression that it is.
Test Plan
The change renders like this locally (
make html):