docs: fix doc-comment typos and mismatches in public headers#15
Draft
smaheshwar-pltr wants to merge 1 commit into
Draft
docs: fix doc-comment typos and mismatches in public headers#15smaheshwar-pltr wants to merge 1 commit into
smaheshwar-pltr wants to merge 1 commit into
Conversation
- schema.h: "canocinal" -> "canonical" - file_io.h: Write/Delete/DeleteFiles \return docs said "void" but these return Status - partition_spec.h: \param allowMissingFields -> allow_missing_fields - expression/json_serde_internal.h: \param typeStr -> json (actual parameter) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
What
Fix incorrect or stale Doxygen comments in public headers. Comments only — no code changes.
schema.h: typo "canocinal" → "canonical" inFindColumnNameById's\return.file_io.h: the\returndocs forWriteFile/DeleteFile/DeleteFilessaid "void", but these methods returnStatus. Reworded to "Status indicating success, or an error if …", matching the existing\return Status indicating …style used elsewhere (e.g.schema.h,catalog.h).partition_spec.h:\param allowMissingFields→allow_missing_fieldsto match theMake(...)signature.expression/json_serde_internal.h:OperationTypeFromJsondocumented a non-existent\param typeStr; corrected to\param json(the actual parameter).Why
Keep the public API documentation accurate and consistent so generated docs and IDE tooltips match the declarations.