docs: fix typos and outdated references in README#286
Open
mahmoodhamdi wants to merge 1 commit intovercel:mainfrom
Open
docs: fix typos and outdated references in README#286mahmoodhamdi wants to merge 1 commit intovercel:mainfrom
mahmoodhamdi wants to merge 1 commit intovercel:mainfrom
Conversation
- Fix variable name typo in parseStrict example (`str` → `s`) - Fix invalid catch clause type annotation (`error: Error` → `error`) - Update Edge Runtime example to use `runtime: 'edge'` instead of the deprecated `'experimental-edge'` - Remove outdated `canary` install comments from Edge example - Replace `npm link` workflow with `pnpm install` + `pnpm test` - Remove orphaned footnote about Internet Explorer Ref vercel#240
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
1 participant
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.
Summary
Noticed a few issues while reading the README ahead of the v4 launch:
parseStrictexample typo: parameter is namedsbut the function body referencesstr, which would confuse anyone copy-pasting the examplecatch (error: Error)is not valid TS — catch clause annotations can only beanyorunknownruntime: 'experimental-edge'was renamed to'edge'back in Next.js 12.3npm linkworkflow, updated topnpm install+pnpm testto match the actual setup[^1]: Internet Explorer is not supportedhad no corresponding reference in the documentNo code changes — documentation only.
Ref #240