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.

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

📝 Tweak cache management utils page #1113

Conversation

Shrugsy
Copy link
Collaborator

@Shrugsy Shrugsy commented May 30, 2021

Marked as draft until #1092 is merged - will be rebased after that and taken off draft status.

Related to #964

  • Adds missing items to the 'cache management utils' page (invalidateTags and resetApiState), as well as very slightly expanding some of the existing items.
  • Copies the descriptions + examples onto docblocks for the corresponding properties in order to provide IDE hover tooltips.
  • Re-titles the sidebar item from Cache Management to Cache Management Utils, with the intent to make it more obvious to users looking for the page that corresponds to api.utils

@codesandbox-ci
Copy link

codesandbox-ci bot commented May 30, 2021

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 9bb9928:

Sandbox Source
Vanilla Configuration
Vanilla Typescript Configuration
rsk-github-issues-example Configuration

@netlify
Copy link

netlify bot commented May 30, 2021

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

🔨 Explore the source changes: 9bb9928

🔍 Inspect the deploy log: https://app.netlify.com/sites/redux-starter-kit-docs/deploys/60b6dabe30d4b30007e7741e

😎 Browse the preview: https://deploy-preview-1113--redux-starter-kit-docs.netlify.app

@Shrugsy Shrugsy changed the title Docs - tweak cache management utils page 📝 Tweak cache management utils page May 30, 2021
@Shrugsy Shrugsy force-pushed the docs/tweak-cache-management-utils-page branch from 7cab34e to 14510eb Compare June 1, 2021 11:10
* Re-title sidebar title for clarity
* Add `invalidateTags` section
* Add `resetApiState` section
* Add descriptions to `api.util` docblocks
@Shrugsy Shrugsy force-pushed the docs/tweak-cache-management-utils-page branch from 14510eb to 17ba875 Compare June 2, 2021 00:39
@Shrugsy Shrugsy marked this pull request as ready for review June 2, 2021 00:58
@Shrugsy Shrugsy force-pushed the docs/tweak-cache-management-utils-page branch from fbb5f7a to 9bb9928 Compare June 2, 2021 01:11
@msutkowski msutkowski merged commit b1e4438 into reduxjs:feature/v1.6-integration Jun 2, 2021
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.

2 participants