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

docs: document hook properties #416

Merged
merged 4 commits into from
Jun 22, 2022
Merged

docs: document hook properties #416

merged 4 commits into from
Jun 22, 2022

Conversation

wadjih-bencheikh18
Copy link
Member

closes : #415

@netlify
Copy link

netlify bot commented Jun 7, 2022 •
edited
Loading

✅ Deploy Preview for react-plot ready!

Name Link
🔨 Latest commit 12b3d51
🔍 Latest deploy log https://app.netlify.com/sites/react-plot/deploys/62ac853f33725200080a7985
😎 Deploy Preview https://deploy-preview-416--react-plot.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

stropitek
stropitek reviewed Jun 8, 2022
View reviewed changes
Copy link
Contributor

@stropitek stropitek left a comment

Choose a reason for hiding this comment

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

I left a few comments in the code but try to review them all with this in mind:

  • Don't paraphrase the name of the prop. Try when possible to give additional context.
  • Use sentences (starts with an Uppercase and ends with a ., no PascalCase / camelCase)

src/hooks/useAxisWheelZoom.tsx Outdated Show resolved Hide resolved
src/hooks/useAxisWheelZoom.tsx Outdated Show resolved Hide resolved
src/hooks/useAxisWheelZoom.tsx Outdated Show resolved Hide resolved
src/hooks/useAxisZoom.tsx Outdated Show resolved Hide resolved
src/hooks/useCrossHair.tsx Outdated Show resolved Hide resolved
src/hooks/useCrossHair.tsx Outdated Show resolved Hide resolved
src/hooks/useDrawRectangle.tsx Outdated Show resolved Hide resolved
src/hooks/useDrawPath.tsx Outdated Show resolved Hide resolved
src/hooks/useDrawPath.tsx Outdated Show resolved Hide resolved
@stropitek stropitek changed the title docs: addDocs to hooks docs: document hook properties Jun 8, 2022
stropitek
stropitek reviewed Jun 17, 2022
View reviewed changes
src/hooks/useCrossHair.tsx Outdated Show resolved Hide resolved
src/hooks/useCrossHair.tsx Outdated Show resolved Hide resolved
src/hooks/useCrossHair.tsx Outdated Show resolved Hide resolved
src/hooks/useCrossHair.tsx Outdated Show resolved Hide resolved
src/hooks/useCrossHair.tsx Outdated Show resolved Hide resolved
src/hooks/useAxisZoom.tsx Outdated Show resolved Hide resolved
@stropitek
Copy link
Contributor

LGTM after the typos are fixed

@wadjih-bencheikh18
Copy link
Member Author

@stropitek typos fixed, thanks

@stropitek stropitek merged commit 11cbde7 into zakodium-oss:main Jun 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stropitek stropitek stropitek left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

docs: add tsdoc in the code
2 participants
@wadjih-bencheikh18 @stropitek