feat(react, react-query-4): add missing JSDoc for react and react-query-4 #1365
Conversation
This file contains 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
People can be co-author:
|
🦋 Changeset detectedLatest commit: dc2fb49 The changes in this PR will be included in the next version bump. This PR includes changesets to release 5 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Size Change: -4 B (-0.01%) Total Size: 64.2 kB
ℹ️ View Unchanged
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1365 +/- ##
=======================================
Coverage 71.86% 71.86%
=======================================
Files 67 67
Lines 583 583
Branches 129 129
=======================================
Hits 419 419
Misses 151 151
Partials 13 13
|
CodSpeed Performance ReportMerging #1365 will create unknown performance changesComparing Summary
|
kangju2000
commented
Nov 20, 2024
| @@ -6,4 +6,8 @@ export interface ClientOnlyProps { | |||
| fallback?: ReactNode | |||
| } | |||
|
|
|||
| /** | |||
| * This component ensures its children are only rendered on the client-side. | |||
| * @see {@link https://suspensive.org/docs/react/ClientOnly Suspensive Docs} | |||
There was a problem hiding this comment.
Which one do you prefer between https://suspensive.org/docs and https://suspensive.org/en/docs
There was a problem hiding this comment.
https://suspensive.org/docs is proper in my opinion. because https://suspensive.org/docs will automatically redirect user's page to proper language page if user use any language
There was a problem hiding this comment.
It would be good to standardize it to links without 'en' since they're not unified!
There was a problem hiding this comment.
Oh,, I merge this Pull Request. could you do that in next pull request please?
There was a problem hiding this comment.
Yes, I'll raise a PR to standardize the jsDoc overall!
1 task
manudeli
pushed a commit
that referenced
this pull request
Nov 21, 2024
…1368) # Overview <!-- A clear and concise description of what this pr is about. --> #1365 (comment) ## PR Checklist - [x] I did below actions if need 1. I read the [Contributing Guide](https://github.com/toss/suspensive/blob/main/CONTRIBUTING.md) 2. I added documents and tests.
manudeli
added a commit
that referenced
this pull request
Nov 21, 2024
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @suspensive/jotai@2.18.6 ### Patch Changes - [#1364](#1364) [`9db2983`](9db2983) Thanks [@kangju2000](https://github.com/kangju2000)! - fix(\*): fix typo in jsdoc - [#1364](#1364) [`9db2983`](9db2983) Thanks [@kangju2000](https://github.com/kangju2000)! - fix(react-query, jotai, react): fix typo in jsdoc ## @suspensive/react@2.18.6 ### Patch Changes - [#1368](#1368) [`30b39d9`](30b39d9) Thanks [@kangju2000](https://github.com/kangju2000)! - docs(react-query, react): Update jsdoc link from `en/docs` to `docs` - [#1365](#1365) [`89c1cd9`](89c1cd9) Thanks [@kangju2000](https://github.com/kangju2000)! - feat(react, react-query-4): add missing JSDoc for react and react-query-4 - [#1364](#1364) [`9db2983`](9db2983) Thanks [@kangju2000](https://github.com/kangju2000)! - fix(\*): fix typo in jsdoc - [#1364](#1364) [`9db2983`](9db2983) Thanks [@kangju2000](https://github.com/kangju2000)! - fix(react-query, jotai, react): fix typo in jsdoc ## @suspensive/react-query@2.18.6 ### Patch Changes - Updated dependencies \[[`30b39d9`](30b39d9), [`89c1cd9`](89c1cd9), [`9db2983`](9db2983), [`9db2983`](9db2983)]: - @suspensive/react-query-4@2.18.6 - @suspensive/react-query-5@2.18.6 - @suspensive/react@2.18.6 ## @suspensive/react-query-4@2.18.6 ### Patch Changes - [#1368](#1368) [`30b39d9`](30b39d9) Thanks [@kangju2000](https://github.com/kangju2000)! - docs(react-query, react): Update jsdoc link from `en/docs` to `docs` - [#1365](#1365) [`89c1cd9`](89c1cd9) Thanks [@kangju2000](https://github.com/kangju2000)! - feat(react, react-query-4): add missing JSDoc for react and react-query-4 - [#1364](#1364) [`9db2983`](9db2983) Thanks [@kangju2000](https://github.com/kangju2000)! - fix(\*): fix typo in jsdoc - [#1364](#1364) [`9db2983`](9db2983) Thanks [@kangju2000](https://github.com/kangju2000)! - fix(react-query, jotai, react): fix typo in jsdoc - Updated dependencies \[[`30b39d9`](30b39d9), [`89c1cd9`](89c1cd9), [`9db2983`](9db2983), [`9db2983`](9db2983)]: - @suspensive/react@2.18.6 ## @suspensive/react-query-5@2.18.6 ### Patch Changes - [#1368](#1368) [`30b39d9`](30b39d9) Thanks [@kangju2000](https://github.com/kangju2000)! - docs(react-query, react): Update jsdoc link from `en/docs` to `docs` - [#1364](#1364) [`9db2983`](9db2983) Thanks [@kangju2000](https://github.com/kangju2000)! - fix(\*): fix typo in jsdoc - [#1364](#1364) [`9db2983`](9db2983) Thanks [@kangju2000](https://github.com/kangju2000)! - fix(react-query, jotai, react): fix typo in jsdoc - Updated dependencies \[[`30b39d9`](30b39d9), [`89c1cd9`](89c1cd9), [`9db2983`](9db2983), [`9db2983`](9db2983)]: - @suspensive/react@2.18.6
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Overview
I add JSDoc comments to
@suspensive/reactand@suspensive/react-query-4.PR Checklist