Skip to content

Assorted outstanding docs improvements #3738

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

Merged
merged 7 commits into from
Sep 24, 2023
Merged

Conversation

markerikson
Copy link
Collaborator

@markerikson markerikson commented Sep 23, 2023

This PR:

  • Updates the configureStore API reference to clarify its purpose and what it does
  • Updates the createSlice API reference to clarify what extraReducers does, and warn about the removal of the object form
  • Fixes broken links in matching-utilities
  • Updates the "Customizing Queries" page to give a couple simple examples of using queryFn with a random async API and a third-party SDK, and emphasizes _returning {error} from both base queries and query functions
  • Clarifies the <ReturnType, ArgType> generics for RKTQ queries and mutations
  • Documents the AtLeastOne<T> workaround for partial payload fields

Fixes #2926
Fixes #2238
Fixes #3113
Fixes #2130
Fixes #1423

@codesandbox
Copy link

codesandbox bot commented Sep 23, 2023

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

@netlify
Copy link

netlify bot commented Sep 23, 2023

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

Name Link
🔨 Latest commit d7fb5ef
🔍 Latest deploy log https://app.netlify.com/sites/redux-starter-kit-docs/deploys/650f5980caeaed0008589fcf
😎 Deploy Preview https://deploy-preview-3738--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 site configuration.

@codesandbox-ci
Copy link

codesandbox-ci bot commented Sep 23, 2023

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 d7fb5ef:

Sandbox Source
Vanilla Configuration
Vanilla Typescript Configuration
rsk-github-issues-example Configuration
@examples-query-react/basic Configuration
@examples-query-react/advanced Configuration
@examples-action-listener/counter Configuration

@@ -162,6 +163,14 @@ See [the "Builder Callback Notation" section of the `createReducer` reference](.

### The `extraReducers` "map object" notation

:::caution

The "map object" notation is deprecated and will be removed in RTK 2.0. Please migrate to the "builder callback" notation, which offers much better TypeScript support and more flexibility.
Copy link
Collaborator

Choose a reason for hiding this comment

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

worth linking to the codemod page?

@markerikson markerikson merged commit d8db6f7 into master Sep 24, 2023
@aryaemami59 aryaemami59 deleted the docs/2238-docs-updates branch January 3, 2025 07:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants