doc: address various uses of "obvious" and "obviously" - #32457
Closed
Trott wants to merge 3 commits into
Closed
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Remove "obvious" and "obviously" in two places in esm.md. It may be obvious to some, but likely not everyone or else it probably wouldn't be worth mentioning/documenting.
Since the previous sentence describes `10` as a default, and the following sentence explains how to modify that default, it is unnecessary to explain that "Obviously, not all events should be limited to just 10 listeners."
jasnell
approved these changes
Mar 24, 2020
MylesBorins
approved these changes
Mar 26, 2020
MylesBorins
left a comment
Copy link
Copy Markdown
Contributor
There was a problem hiding this comment.
LGTM
Sorry, something went wrong.
MylesBorins
pushed a commit
that referenced
this pull request
Mar 26, 2020
PR-URL: #32457 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 26, 2020
Remove "obvious" and "obviously" in two places in esm.md. It may be obvious to some, but likely not everyone or else it probably wouldn't be worth mentioning/documenting. PR-URL: #32457 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 26, 2020
Since the previous sentence describes `10` as a default, and the following sentence explains how to modify that default, it is unnecessary to explain that "Obviously, not all events should be limited to just 10 listeners." PR-URL: #32457 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 26, 2020
PR-URL: #32457 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 26, 2020
Remove "obvious" and "obviously" in two places in esm.md. It may be obvious to some, but likely not everyone or else it probably wouldn't be worth mentioning/documenting. PR-URL: #32457 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Mar 26, 2020
Since the previous sentence describes `10` as a default, and the following sentence explains how to modify that default, it is unnecessary to explain that "Obviously, not all events should be limited to just 10 listeners." PR-URL: #32457 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
Merged
MylesBorins
pushed a commit
to MylesBorins/node
that referenced
this pull request
Apr 3, 2020
Remove "obvious" and "obviously" in two places in esm.md. It may be obvious to some, but likely not everyone or else it probably wouldn't be worth mentioning/documenting. PR-URL: nodejs#32457 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
Apr 3, 2020
Remove "obvious" and "obviously" in two places in esm.md. It may be obvious to some, but likely not everyone or else it probably wouldn't be worth mentioning/documenting. Backport-PR-URL: #32610 PR-URL: #32457 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
Merged
targos
pushed a commit
that referenced
this pull request
Apr 22, 2020
PR-URL: #32457 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
targos
pushed a commit
that referenced
this pull request
Apr 22, 2020
Since the previous sentence describes `10` as a default, and the following sentence explains how to modify that default, it is unnecessary to explain that "Obviously, not all events should be limited to just 10 listeners." PR-URL: #32457 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Myles Borins <myles.borins@gmail.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
4 participants
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.
In one instance, the sentences are unnecessarily long. Simplify the text.
In another instance, the sentence is unnecessary. Remove it.
In two other instances, deleting "obvious(ly)" seems to improve the documentation.
Checklist