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.

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

docs: fix typos in definitions.js #5997

Closed
wants to merge 3 commits into from
Closed

Conversation

ericmutta
Copy link
Contributor

@ericmutta ericmutta commented Dec 25, 2022

Fix a typo in the docs for the --access flag which shows up like this on the site:

image

The sentence "If do not want..." should read "If you do not want...".


Fix a typo in the docs for the --strict-peer-deps flag which shows up like this on the site:

image

The sentence "When such and override is performed" should read "When such an override is performed".


Fix a typo in the docs for the --global-style flag which shows up like this on the site:

image

The sentence "...hoist on deeper dependendencies" should read "...hoist on deeper dependencies".

@ericmutta ericmutta requested a review from a team as a code owner December 25, 2022 22:38
@ericmutta ericmutta changed the title Fix typo in definitions.js Fix typos in definitions.js Dec 31, 2022
@lukekarrys lukekarrys changed the title Fix typos in definitions.js docs: fix typos in definitions.js Jan 1, 2023
@lukekarrys
Copy link
Contributor

@ericmutta our docs are validated via snapshot testing. could you run npm run snap and commit the resulting changes? apologies that this process is not better documented 🙇🏼

Copy link
Contributor

@lukekarrys lukekarrys left a comment

Choose a reason for hiding this comment

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

Needs snapshot updates

@ericmutta
Copy link
Contributor Author

@lukekarrys could you run npm run snap and commit the resulting changes?

I made all the edits in this and other npm-related PRs via the GitHub editor, so I don't have a local setup where I can run that command. If there's a guide I can follow I am happy to try again...alternatively, in the interests of saving time, I am also OK if you were to fix the minor typos on your existing setup and commit that 👍

PS: kudos to you and the team for working on the NPM docs - they are easy to read and have turned me into "an NPM believer" 😄

@lukekarrys
Copy link
Contributor

Thank you @ericmutta! I took your commits and opened #6038 which also updates the snapshots.

@lukekarrys lukekarrys closed this Jan 9, 2023
@ericmutta
Copy link
Contributor Author

Awesome @lukekarrys, many thanks! 🔥

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants