docs(guides): minor fixes and typos #4419
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
two of these have periods and two don't... so I looked around at what is done elsewhere and took my best guess
at this point in the readthrough, this is the very first time I'm seeing anything about "options" and having a link to one is nice, just to quickly see what they look like and hop right back to this page. I'd love to add some docs to the 4 that are mentioned in the next paragraph but they don't seem to have a way to link to them since they're contained in an unordered list on the useQuery page
I don't see how to run the docs site locally to test this, but at least on GitHub's markdown parser this would really help align the quote block with the associated bullet (as it is today is sorta hard to follow because some are global and some are attached to bullets, yet they're all at the same level). feel free to drop this commit if it doesn't work for the actual markdown parser.
see https://github.com/TanStack/query/blob/759aa0a89c593ab452316b799d952153752ac1c9/packages/query-core/src/types.ts#L24 following the standard of https://www.typescriptlang.org/tsconfig#exactOptionalPropertyTypes these types are subtly incorrect.
check out https://tanstack.com/query/v4/docs/guides/background-fetching-indicators#displaying-global-background-fetching-loading-state and see that the section that's an h1 at the bottom is pushed pretty hard up against the codeblock before it. I think this is some kind of tailwind problem, but it's a win-win because a page having multiple h1 elements is an accessibility nit anyways
|
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 ad1c801:
|
dimitropoulos
commented
Oct 31, 2022
| ``` | ||
|
|
||
| # Displaying Global Background Fetching Loading State | ||
| ## Displaying Global Background Fetching Loading State |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm doing a full read-through of the docs, and I noticed a few minor things along the way. I'm very low-ego about these changes, but thought I'd submit them. I'd be happy to pull each commit into separate PRs if you like, but each commit has a description and should be atomic.
Definitely more to come, but I thought I'd submit what I have for today.