Skip to content

Improve JSDoc comments in @rtk-query/codegen-openapi #5032

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

issy
Copy link

@issy issy commented Jul 15, 2025

I wasn't that happy with the way the default values for fields in the codegen types rendered in my IDE. After some small tweaks to the JSDoc comments, it looks much better.

Before:

image

After:

image

Copy link

codesandbox bot commented Jul 15, 2025

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

Copy link

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 2dd410d:

Sandbox Source
@examples-query-react/basic Configuration
@examples-query-react/advanced Configuration
@examples-action-listener/counter Configuration
rtk-esm-cra Configuration

Copy link

netlify bot commented Jul 15, 2025

Deploy Preview for redux-starter-kit-docs ready!

Name Link
🔨 Latest commit 2dd410d
🔍 Latest deploy log https://app.netlify.com/projects/redux-starter-kit-docs/deploys/68766d718f1f63000889f6d6
😎 Deploy Preview https://deploy-preview-5032--redux-starter-kit-docs.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 project configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant