Improve documentation for basic array methods #41961
Merged
Conversation
This file contains hidden or 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
typescript-bot
added
the
For Uncommitted Bug
|
This PR doesn't have any linked issues. Please open an issue that references this PR. From there we can discuss and prioritise. |
|
|
|
Thanks, I like these changes: it looks like in the JSDoc we quite regularly jump between "Array" vs "array", and "String" vs "string" - so while I don't want that to be a blocker on this PR. I'll leave the PR open for a bit to see if anyone has a strong opinion, and I can go and make it all a single case. |
|
Since these usages are not proper nouns, I vote for them to be lowercase, as they are in this change. |
|
Cool, let's get this in then 👍🏻 |
Zzzen
pushed a commit
to Zzzen/TypeScript
that referenced
this pull request
Jan 16, 2021
* Improve documentation for basic array methods * Accept baseline changes for new lines from JSDoc changes Co-authored-by: Orta <[email protected]>
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.
I felt that some of these methods were ambiguous or lacking in detail.
Not sure if this requires an associated issue, but let me know if it does and I can open one.