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

Fix Typo in "with-eslint" Example docs #28601

Merged
merged 3 commits into from
Sep 7, 2021
Merged

Conversation

appsplash99
Copy link
Contributor

Earlier it was:

npx create-next-app --example with-eslint with-eslint
# or
yarn create next-app --example with-eslint with-eslint

It was confusing for me,
as i couldn't identify which one is example-name and which one is folder-name (for with-eslint).

I checked other example folders and was able to digest the stuff.
But if a new programmer comes who is not familiar with next/npx,
this could have took some time to understand.

And Hence i modified the cmd it to the below, for better understanding:

npx create-next-app --example with-eslint with-eslint-app
# or
yarn create next-app --example with-eslint with-eslint-app

Documentation / Examples

  • Make sure the linting passes

Earlier it was:

```bash
npx create-next-app --example with-eslint with-eslint
# or
yarn create next-app --example with-eslint with-eslint
```

It was confusing for me, 
as i couldn't identify which one is *example-name* and which one is *folder-name* (for *with-eslint*).

I checked other example folders and was able to digest the stuff.
And Hence i modified the cmd it to  the below, for better understanding:

```bash
npx create-next-app --example with-eslint with-eslint-app
# or
yarn create next-app --example with-eslint with-eslint-app
```
@ijjk ijjk added the examples Issue/PR related to examples label Aug 29, 2021
@kodiakhq kodiakhq bot merged commit 429f63d into vercel:canary Sep 7, 2021
bordeo pushed a commit to filoblu/next.js that referenced this pull request Sep 8, 2021
* canary:
  v11.1.3-canary.14
  Ensure timed out prefetches are cleaned up correctly (vercel#28899)
  Fix/swc minify (vercel#28898)
  Update concurrent tests and enable experimental streaming (vercel#28892)
  Fix Typo in "with-eslint" Example docs (vercel#28601)
  Examples Prepr CMS update (vercel#28871)
  fixes with-typescript-graphql: unable to resolve dependency tree (vercel#28637)
  Update `next/link` API docs to mention a11y and ESLint rule. (vercel#28841)
  Trim large test output to not exceed limit (vercel#28881)
  Updates @react-three/drei version and other dependencies. (vercel#28755)
  Remove unused dependencies (vercel#28876)
@vercel vercel locked as resolved and limited conversation to collaborators Jan 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
examples Issue/PR related to examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants