docs: fix inline examples, deprecation descriptions, type category#4757
Merged
Conversation
|
@yaacovCR is attempting to deploy a commit to the The GraphQL Foundation Team on Vercel. A member of the Team first needs to authorize it. |
Move public documentation sample blocks out of descriptions and into @example tags, including root package, parser option, type, schema, astFromValue, and stripIgnoredCharacters docs.
Update every public v16 @deprecated JSDoc block so the prose itself says the API is deprecated and points users to the replacement or migration path.
Rename the graphql/type Definitions JSDoc category to Types so the generated API docs use the clearer category name.
8fa9286 to
df971aa
Compare
yaacovCR
added a commit
to yaacovCR/graphql-js
that referenced
this pull request
Jun 1, 2026
## v16.14.1 (2026-06-02) #### Docs 📝 <details> <summary> 9 PRs were merged </summary> * [graphql#4737](graphql#4737) docs: refresh upgrade guide and v17 topics ([@yaacovCR](https://github.com/yaacovCR)) * [graphql#4741](graphql#4741) docs: add v16 API docs lint coverage ([@yaacovCR](https://github.com/yaacovCR)) * [graphql#4748](graphql#4748) docs: update banner ([@yaacovCR](https://github.com/yaacovCR)) * [graphql#4750](graphql#4750) docs: use api docs generated from inline jsdoc comments ([@yaacovCR](https://github.com/yaacovCR)) * [graphql#4754](graphql#4754) docs: update website caniuse-lite data ([@yaacovCR](https://github.com/yaacovCR)) * [graphql#4755](graphql#4755) docs: hide internal type member __validationErrors ([@yaacovCR](https://github.com/yaacovCR)) * [graphql#4757](graphql#4757) docs: fix inline examples, deprecation descriptions, type category ([@yaacovCR](https://github.com/yaacovCR)) * [graphql#4759](graphql#4759) docs: fix static export redirect config ([@yaacovCR](https://github.com/yaacovCR)) * [graphql#4767](graphql#4767) docs: fix Post_body example variable ([@fallintoplace](https://github.com/fallintoplace)) </details> #### Polish 💅 * [graphql#4738](graphql#4738) chore(tests): add test for directive extensions without flag enabled ([@yaacovCR](https://github.com/yaacovCR)) #### Internal 🏠 * [graphql#4778](graphql#4778) fix: generated version documentation ([@yaacovCR](https://github.com/yaacovCR)) #### Committers: 2 * Minh Vu([@fallintoplace](https://github.com/fallintoplace)) * Yaacov Rydzinski ([@yaacovCR](https://github.com/yaacovCR))
yaacovCR
added a commit
that referenced
this pull request
Jun 1, 2026
## v16.14.1 (2026-06-02) #### Docs 📝 <details> <summary> 9 PRs were merged </summary> * [#4737](#4737) docs: refresh upgrade guide and v17 topics ([@yaacovCR](https://github.com/yaacovCR)) * [#4741](#4741) docs: add v16 API docs lint coverage ([@yaacovCR](https://github.com/yaacovCR)) * [#4748](#4748) docs: update banner ([@yaacovCR](https://github.com/yaacovCR)) * [#4750](#4750) docs: use api docs generated from inline jsdoc comments ([@yaacovCR](https://github.com/yaacovCR)) * [#4754](#4754) docs: update website caniuse-lite data ([@yaacovCR](https://github.com/yaacovCR)) * [#4755](#4755) docs: hide internal type member __validationErrors ([@yaacovCR](https://github.com/yaacovCR)) * [#4757](#4757) docs: fix inline examples, deprecation descriptions, type category ([@yaacovCR](https://github.com/yaacovCR)) * [#4759](#4759) docs: fix static export redirect config ([@yaacovCR](https://github.com/yaacovCR)) * [#4767](#4767) docs: fix Post_body example variable ([@fallintoplace](https://github.com/fallintoplace)) </details> #### Polish 💅 * [#4738](#4738) chore(tests): add test for directive extensions without flag enabled ([@yaacovCR](https://github.com/yaacovCR)) #### Internal 🏠 * [#4778](#4778) fix: generated version documentation ([@yaacovCR](https://github.com/yaacovCR)) #### Committers: 2 * Minh Vu([@fallintoplace](https://github.com/fallintoplace)) * Yaacov Rydzinski ([@yaacovCR](https://github.com/yaacovCR))
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
@exampletags, including root package, parser option, type, schema, astFromValue, and stripIgnoredCharacters docs.@deprecatedJSDoc block so the prose itself says the API is deprecated and points users to the replacement or migration path.