docs: fix public API comment mismatches - #15
Open
smaheshwar-pltr wants to merge 1 commit into
Open
smaheshwar-pltr wants to merge 1 commit into
smaheshwar-pltr wants to merge 1 commit into
Conversation
smaheshwar-pltr
force-pushed
the
cleanup/header-doc-comments
branch
from
September 6, 2026 22:05
20a4c40 to
a59071f
Compare
smaheshwar-pltr
changed the title
smaheshwar-pltr
marked this pull request as ready for review
September 7, 2026 01:07
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.
Fix four stale or incorrect API comments: the canonical-name typo,
Statusreturn descriptions on FileIO methods, theallow_missing_fieldsparameter name, and the JSON parameter name forOperationTypeFromJson.Validation:
pre-commitpassed for the complete diff.AI assistance: Codex was used to rebase and review the existing documentation change. I reviewed the resulting diff and validation.