docs: fix undefined variable and inaccurate peer-deps note in README#6301
Open
maxim-belyakov wants to merge 1 commit into
Open
docs: fix undefined variable and inaccurate peer-deps note in README#6301maxim-belyakov wants to merge 1 commit into
maxim-belyakov wants to merge 1 commit into
Conversation
- Correct `startdate` -> `startDate` in the basic-usage example so the snippet references the state variable it defines (previously threw "startdate is not defined" when copy-pasted). - Replace the outdated "React and PropTypes" install note with "React and react-dom": the package is TypeScript and declares no prop-types peer dependency; react and react-dom are the actual peers.
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.
What
Two small getting-started documentation fixes in
README.md:Undefined variable in example - the "most basic use" snippet used
selected={startdate}(lowercase) while the surrounding example definesstartDate/setStartDate. Copy-pasting threwstartdate is not defined.Inaccurate install note - the README told users to install
"React and PropTypes" separately. The package is TypeScript with no
prop-typespeer dependency; the real peers arereactandreact-dom.Docs-only - no code or behavior changed.