search

apollographql / apollo-client

:rocket:  A fully-featured, production ready caching GraphQL client for every UI framework and GraphQL server.
https://apollographql.com/client
MIT License
19.38k stars 2.66k forks source link

`useQuery` API documentation anchor links are all `#undefined` #11687

Closed zmsy closed 8 months ago

zmsy commented 8 months ago

Issue Description

In the API docs, all of the anchor links for API options properties are currently #undefined.

Trying to get some of the team to adopt more idiomatic usage of useQuery options and it's difficult right now without being able to link the docs to the actual option itself.

Appears to be an issue in ApiDocHeading: https://github.com/apollographql/apollo-client/blob/9c5a8cee40900125fe5037d573e6daedd619075f/docs/shared/ApiDoc/PropertySignatureTable.js#L92

This issue seems to occur in all API docs that use the PropertySignatureTable:

Link to Reproduction

https://www.apollographql.com/docs/react/data/mutations/#options

Reproduction Steps

Select/hover any links below Options section here: https://www.apollographql.com/docs/react/data/mutations/#options

@apollo/client version

3.6.9 (though this is just a docs concern)

alessbell commented 8 months ago

Hey @zmsy 👋 Thanks for opening the issue, will take a look.

github-actions[bot] commented 8 months ago

Do you have any feedback for the maintainers? Please tell us by taking a one-minute survey. Your responses will help us understand Apollo Client usage and allow us to serve you better.

alessbell commented 8 months ago

@zmsy Deploying the fix now, thanks again :)

github-actions[bot] commented 7 months ago

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. For general questions, we recommend using StackOverflow or our discord server.