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

doc: fix typos #55066

Merged
merged 2 commits into from
Sep 29, 2024
Merged

doc: fix typos #55066

merged 2 commits into from
Sep 29, 2024

Conversation

NathanBaulch
Copy link
Contributor

Just thought I'd contribute some typo fixes that I stumbled on. Nothing controversial (hopefully).

Use the following command to get a quick summary of the specific corrections made:

git diff HEAD^! --word-diff-regex='\w+' -U0 \
  | grep -E '\[\-.*\-\]\{\+.*\+\}' \
  | sed -r 's/.*\[\-(.*)\-\]\{\+(.*)\+\}.*/\1 \2/' \
  | sort | uniq -c | sort -n

FWIW, the top typos are:

  • udpate (9)
  • flakyness (8)
  • protoype (6)
  • uneeded (6)
  • transferrable (5)
  • suport (4)
  • clearify (4)
  • prototoype (4)
  • unecessary (4)
  • execption (3)
  • existance (3)
  • sypnosis (3)
  • comparions (3)
  • explicity (3)
  • sript (3)
  • iin (3)
  • interuption (3)
  • unnecesary (3)

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/crypto
  • @nodejs/loaders
  • @nodejs/test_runner
  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Sep 22, 2024
panva
panva reviewed Sep 22, 2024
View reviewed changes
Copy link
Member

@panva panva left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove changes to CHANGELOG entries.

doc/api/crypto.md
@@ -5968,7 +5968,7 @@ See the [list of SSL OP Flags][] for details.
</tr>
<tr>
<td><code>ENGINE_METHOD_PKEY_METHS</code></td>
<td>Limit engine usage to PKEY_METHDS</td>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not a typo per se, it comes from an upstream dependency

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@panva this is not aligned with rest of the file though:

atlowChemi
atlowChemi reviewed Sep 22, 2024
View reviewed changes
Copy link
Member

@atlowChemi atlowChemi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure we should change the changelogs, not sure if there is any rules about it either.
Maybe @nodejs/releasers can give some input?

doc/api/crypto.md
@@ -5968,7 +5968,7 @@ See the [list of SSL OP Flags][] for details.
</tr>
<tr>
<td><code>ENGINE_METHOD_PKEY_METHS</code></td>
<td>Limit engine usage to PKEY_METHDS</td>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@panva this is not aligned with rest of the file though:

@NathanBaulch
Copy link
Contributor Author

I've restored the (many!) changelog typos, let me know if I should squash my commits (assuming the final merge isn't squashed).

@RedYetiDev RedYetiDev added the commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. label Sep 23, 2024
@RedYetiDev
Copy link
Member

I've restored the (many!) changelog typos, let me know if I should squash my commits (assuming the final merge isn't squashed).

They will be squashed automatically, no worries :-)

@lpinca
Copy link
Member

lpinca commented Sep 27, 2024

Can you please resolve conflicts?

mertcanaltin
mertcanaltin approved these changes Sep 29, 2024
View reviewed changes
Copy link
Member

@mertcanaltin mertcanaltin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@lpinca lpinca added the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 29, 2024
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Sep 29, 2024
@nodejs-github-bot nodejs-github-bot merged commit 22b4b7c into nodejs:main Sep 29, 2024
17 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 22b4b7c

@NathanBaulch NathanBaulch deleted the typos-doc branch September 29, 2024 21:10
@targos targos added the backport-blocked-v22.x PRs that should land on the v22.x-staging branch but are blocked by another PR's pending backport. label Oct 5, 2024
@targos
Copy link
Member

targos commented Oct 5, 2024

Should land after #55217

@aduh95 aduh95 mentioned this pull request Oct 14, 2024
Merged
louwers pushed a commit to louwers/node that referenced this pull request Nov 2, 2024
@NathanBaulch @louwers
doc: fix typos
0a45d22 
PR-URL: nodejs#55066
Reviewed-By: Luigi Pinca <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@panva panva panva left review comments

@atlowChemi atlowChemi atlowChemi left review comments

@lpinca lpinca lpinca approved these changes

@mertcanaltin mertcanaltin mertcanaltin approved these changes

Assignees
No one assigned
Labels
backport-blocked-v22.x PRs that should land on the v22.x-staging branch but are blocked by another PR's pending backport. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. doc Issues and PRs related to the documentations.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@NathanBaulch @nodejs-github-bot @RedYetiDev @lpinca @targos @panva @mertcanaltin @atlowChemi