Update doc blocks for utilities - #12831
Merged
Merged
Conversation
|
commit: |
Contributor
size-limit report 📦
|
Contributor
✅ Docs preview readyThe preview is ready to be viewed. View the preview File Changes 26 new, 66 changed, 5 removedBuild ID: deaf15bc2ef24f3b183e5954 URL: https://www.apollographql.com/docs/deploy-preview/deaf15bc2ef24f3b183e5954 |
Member
|
!docs set-base-branch main |
phryneas
approved these changes
Aug 8, 2025
|
|
||
| /** | ||
| * Adds `__typename` to all selection sets in the document. | ||
| * Adds `__typename` to all selection sets in the document. The operation |
Member
There was a problem hiding this comment.
Suggested change
| * Adds `__typename` to all selection sets in the document. The operation | |
| * Adds `__typename` to all selection sets in the document. Beyond that, the operation |
The original sentence confused me a bit - is this what you mean?
| /** | ||
| * Adds `__typename` to all selection sets in the document. | ||
| * Adds `__typename` to all selection sets in the document. The operation | ||
| * definition's selection set remains unchanged. |
Member
There was a problem hiding this comment.
Suggested change
| * definition's selection set remains unchanged. | |
| * Adds `__typename` to all selection sets in the document. | |
| * Returns a modified copy - the original document is not mutated. |
Or did you mean this?
Member
Author
There was a problem hiding this comment.
Not quite. I was trying to get at the fact we don't add __typename to the root selection set (perhaps I just use that exact phrase 🤣). Meaning:
const query = gql`
query {
__typename # this field is not added by `addTypenameToDocument`
}
`;| * `; | ||
| * | ||
| * isMutationOperation(mutation); // true | ||
| * ``` |
Member
There was a problem hiding this comment.
Suggested change
| * ``` | |
| * ``` | |
| * | |
| * @remark | |
| * If you are authoring a link, you might not need to use this utility. | |
| * Use the `operationType` passed into the link as a property on the `operation` argument instead. |
Do you think it makes sense to add this remark to all three functions?
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 started down the path of adding documentation for our utilities, but there are some missing component primitives that we need to add before we can do this successfully. I went ahead and added the additions suggested by claude (and refined) to the doc blocks as I felt these were worth to be kept.