docs: fix inline examples, deprecation descriptions, type category#4758
Merged
Conversation
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 v17 @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.
|
@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. |
yaacovCR
added a commit
that referenced
this pull request
Jun 1, 2026
## v17.0.0-beta.2 (2026-06-02) #### Breaking Change 💥 * [#4751](#4751) build: strip private discriminator from package types ([@yaacovCR](https://github.com/yaacovCR)) * [#4752](#4752) fix: discriminate between GraphQLNonNull and GraphQLList ([@yaacovCR](https://github.com/yaacovCR)) * [#4770](#4770) refactor: extract ExecutionArgs types to separate file ([@yaacovCR](https://github.com/yaacovCR)) #### New Feature 🚀 * [#4485](#4485) Adopt Error.cause in favor of originalError ([@Malien](https://github.com/Malien)) #### Bug Fix 🐞 * [#4739](#4739) chore(tests): add test for directive extensions without flag enabled (#4738) ([@yaacovCR](https://github.com/yaacovCR)) * [#4743](#4743) api: export VariableValues ([@yaacovCR](https://github.com/yaacovCR)) * [#4744](#4744) api: export ValidationOptions ([@yaacovCR](https://github.com/yaacovCR)) * [#4745](#4745) api: export SchemaChange ([@yaacovCR](https://github.com/yaacovCR)) * [#4746](#4746) api: export defer and stream validation rules ([@yaacovCR](https://github.com/yaacovCR)) * [#4747](#4747) api: export legacy incremental execution functions and helpers ([@yaacovCR](https://github.com/yaacovCR)) * [#4753](#4753) fix(build): development declaration stubs ([@yaacovCR](https://github.com/yaacovCR)) * [#4773](#4773) fix: FragmentVariableValueSource.value can be non-constant ([@yaacovCR](https://github.com/yaacovCR)) * [#4775](#4775) fix: remove unnecessary native promise coercion ([@yaacovCR](https://github.com/yaacovCR)) #### Docs 📝 <details> <summary> 3 PRs were merged </summary> * [#4742](#4742) docs: add v17 API docs lint coverage ([@yaacovCR](https://github.com/yaacovCR)) * [#4756](#4756) docs: hide private internals `schema.__validationErrors` and `inputValue._memoizedCoercedDefaultValue` ([@yaacovCR](https://github.com/yaacovCR)) * [#4758](#4758) docs: fix inline examples, deprecation descriptions, type category ([@yaacovCR](https://github.com/yaacovCR)) </details> #### Polish 💅 * [#4774](#4774) test: restore GraphQLError no-stack coverage ([@yaacovCR](https://github.com/yaacovCR)) #### Internal 🏠 <details> <summary> 3 PRs were merged </summary> * [#4771](#4771) internal: drop node 20 integration tests ([@yaacovCR](https://github.com/yaacovCR)) * [#4772](#4772) internal: add deno 2.8.x to CI ([@yaacovCR](https://github.com/yaacovCR)) * [#4777](#4777) fix: preserve generated version documentation ([@yaacovCR](https://github.com/yaacovCR)) </details> #### Committers: 2 * Yaacov Rydzinski ([@yaacovCR](https://github.com/yaacovCR)) * Yaroslav Petryk([@Malien](https://github.com/Malien))
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.