-
Notifications
You must be signed in to change notification settings - Fork 45
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
[Feature]: More description for target version #1000
Comments
@juno7803 Could you add what you expect as Pull Request? |
I believe that the cli for @suspensive/react-query status clearly supports different versions of react-query for users. However, despite its clear functionality, I find the guidance provided by the CLI to be unclear. If it's alright with you, could I contribute by submitting a Pull Request? 😁 |
@juno7803 I agree, especially the |
SuggestionI made example what I expected. Suspensive React Query with TanStack Query v4
Suspensive React Query with TanStack Query v5
If you have better Idea, Suggest example before developing please! @juno7803 @gwansikk |
Oh, this is really detailed and impressive.
How about including a link to the official documentation for information about the interfaces? |
In my opinion, Linking official doc is not good idea to expose what exactly dist/index.js export at each version because official doc only expose latest public apis So In my opinion, to implement detailed
I agree with your opinion, then how about showing public apis of @suspensive/react-query only, not @tanstack/react-query Suspensive React Query with TanStack Query v4
Suspensive React Query with TanStack Query v5
|
@manudeli I agree with your opinion! Is the method you explained the same as the one written below? Do we provide API information by branching according to the version, or do we dynamically display the code exported by if (suspensiveReactQueryVersion === '5') {
console.log(`
- SuspenseQuery
- SuspenseQueries
- SuspenseInfiniteQuery
- QueryErrorBoundary`)
} else if (suspensiveReactQueryVersion === '4') {
console.log(`
- useSuspenseQuery
- useSuspenseQueries
- useSuspenseInfiniteQuery
- queryOptions
- SuspenseQuery
- SuspenseQueries
- SuspenseInfiniteQuery
- QueryErrorBoundary`)
} |
In my opinion, display dynamically finally is better for me. but if we need to resolve this issue first, I think that displaying public apis by branching according to the version statically will be good solution at this first time! Fast resolve issue, and improving feature gradually also good! @juno7803 How do you think of this way? |
You guys shared a lot of valuable opinions! Thank you so much, and I apologize for the delay. The biggest inconvenience from the user's perspective was understanding what CLI were trying to convey. Therefore, assuming you know the following key features of
At first, instead of specifying which APIs are provided when using with However, after reading the new issue comments, I think it's best to be clear as @manudeli mentioned. (Upon reflection, I realize I have some background knowledge from @manudeli 's explanations of the library concept). While I completely agree with @gwansikk's opinion on readability and maintainability, providing document links is also part of maintainability, but personally, I don't prefer navigating through multiple layers (I think that might feel like depth to some people.), especially in CLI. Therefore, as @manudeli suggested, I think it's best to first resolve the issue by displaying it statically and then improve it through automation. As for how to automate, I might need to study more to contribute as much as those who developed it..! Thank you once again for sharing your valuable opinions! ❤️ |
# Overview I've added you as a co-author! @juno7803 Thank you for your valuable feedback! Thanks to you, the explanation has become even better. I have made the API display static for now. In the next version, I will make it dynamic to list and display the APIs. #1000 (comment) | version 4 | version 5| | --- | --- | |<img width="472" alt="image" src="https://github.com/toss/suspensive/assets/39869096/2e4e4adf-c2db-4b19-bab4-e847075aae09">|<img width="475" alt="image" src="https://github.com/toss/suspensive/assets/39869096/1a5f6afa-d2a5-498b-99f6-a10049ea3fd1">| ## 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. --------- Co-authored-by: Jun <26808056+juno7803@users.noreply.github.com>
# Overview I've added you as a co-author! @juno7803 Thank you for your valuable feedback! Thanks to you, the explanation has become even better. I have made the API display static for now. In the next version, I will make it dynamic to list and display the APIs. #1000 (comment) | version 4 | version 5| | --- | --- | |<img width="472" alt="image" src="https://github.com/toss/suspensive/assets/39869096/2e4e4adf-c2db-4b19-bab4-e847075aae09">|<img width="475" alt="image" src="https://github.com/toss/suspensive/assets/39869096/1a5f6afa-d2a5-498b-99f6-a10049ea3fd1">| ## 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. --------- Co-authored-by: Jun <26808056+juno7803@users.noreply.github.com>
# Overview I've added you as a co-author! @juno7803 Thank you for your valuable feedback! Thanks to you, the explanation has become even better. I have made the API display static for now. In the next version, I will make it dynamic to list and display the APIs. #1000 (comment) | version 4 | version 5| | --- | --- | |<img width="472" alt="image" src="https://github.com/toss/suspensive/assets/39869096/2e4e4adf-c2db-4b19-bab4-e847075aae09">|<img width="475" alt="image" src="https://github.com/toss/suspensive/assets/39869096/1a5f6afa-d2a5-498b-99f6-a10049ea3fd1">| ## 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. ---------
# Overview I've added you as a co-author! @juno7803 Thank you for your valuable feedback! Thanks to you, the explanation has become even better. I have made the API display static for now. In the next version, I will make it dynamic to list and display the APIs. #1000 (comment) | version 4 | version 5| | --- | --- | |<img width="472" alt="image" src="https://github.com/toss/suspensive/assets/39869096/2e4e4adf-c2db-4b19-bab4-e847075aae09">|<img width="475" alt="image" src="https://github.com/toss/suspensive/assets/39869096/1a5f6afa-d2a5-498b-99f6-a10049ea3fd1">| ## 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. --------- Co-authored-by: Jun <26808056+juno7803@users.noreply.github.com>
# Overview I've added you as a co-author! @juno7803 Thank you for your valuable feedback! Thanks to you, the explanation has become even better. I have made the API display static for now. In the next version, I will make it dynamic to list and display the APIs. #1000 (comment) | version 4 | version 5| | --- | --- | |<img width="472" alt="image" src="https://github.com/toss/suspensive/assets/39869096/2e4e4adf-c2db-4b19-bab4-e847075aae09">|<img width="475" alt="image" src="https://github.com/toss/suspensive/assets/39869096/1a5f6afa-d2a5-498b-99f6-a10049ea3fd1">| ## 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. --------- Co-authored-by: Jun <26808056+juno7803@users.noreply.github.com>
Package Scope
@suspensive/react-query
Bug description
issued by @juno7803
Expected behavior
No response
To Reproduce
No response
Possible Solution
No response
etc.
No response
The text was updated successfully, but these errors were encountered: