Skip to content
This repository has been archived by the owner on Jun 8, 2021. It is now read-only.

Miscellaneous documentation work #203

Merged
merged 2 commits into from
Apr 16, 2021

Conversation

Shrugsy
Copy link
Contributor

@Shrugsy Shrugsy commented Apr 15, 2021

Changelog:

  • Consolidate prettier config into single .prettierrc file
  • Miscellaneous minor updates to existing docs pages
  • Move portions of docs to docblock links
  • Add docblocks to various items
  • Update remark-typescript-tools

Little is actually proposed to change in the docs due to this PR, mainly things like:

  • some spelling fixes
  • some consistency fixes (e.g. updating type defs in the docs to match that in the code)

Where feasible, content that could be an imported docblock was made into an imported docblock.

Unless I missed some, all publicly exported items excluding typedefs should now have a docblock (and hence show additional info when hovered in the IDE). Type defs still need covering in the future.

Note: The intent was to introduce prettier-plugin-jsdoc to allow prettier to format examples in docblocks, but it had some small quirks with how it formatted the rest of the docblock that made me decide to forego it at this stage.

- Consolidate prettier config into single `.prettierrc` file
- Miscellaneous minor updates to existing docs pages
- Move portions of docs to docblock links
- Add docblocks to various items
- Update `remark-typescript-tools`
@codesandbox-ci
Copy link

codesandbox-ci bot commented Apr 15, 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 041e7b3:

Sandbox Source
React Configuration
React Typescript Configuration
rtk-query-demo Configuration
svelte-app-rtk-simplequery-demo Configuration

@Shrugsy
Copy link
Contributor Author

Shrugsy commented Apr 15, 2021

FYI:

For docblock @example tags that have a 'title' in the snippet, they retain the formatting in vscode on hover, but just lose the syntax highlighting:
image

However in codesandbox, the formatting is lost too:
image

Up for discussion: It may be better to not link to examples where a snippet title is desired, and just duplicate the example in the docs.

…faces, move `usePrefetch` TS definition to react module
@phryneas phryneas merged commit f782b25 into rtk-incubator:next Apr 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants