Skip to content

chore: Fix duplicated word typos in comments and docs - #11034

Open
geographybuff wants to merge 2 commits into
apache:mainfrom
geographybuff:fix/doubled-word-comments
Open

chore: Fix duplicated word typos in comments and docs#11034
geographybuff wants to merge 2 commits into
apache:mainfrom
geographybuff:fix/doubled-word-comments

Conversation

@geographybuff

@geographybuff geographybuff commented Sep 9, 2026

Copy link
Copy Markdown

Which issue does this PR close?

N/A — small standalone cleanup, following the precedent of recent comment-typo PRs merged without a linked issue:

Rationale for this change

Several comments contain accidentally doubled words — run-encoded encoded data, and and an offset, typed typed on, are used used. Most are rustdoc on public items, so they render on docs.rs.

These survive automated checking because the CI spell check (.github/ci/scripts/typos_check.sh, the typos crate) matches misspelled words and does not detect a correctly spelled word repeated twice in a row. typos --config typos.toml passes on both the unmodified tree and this branch.

One case is more than cosmetic. In parquet/src/file/metadata/thrift/mod.rs, the PageHeader doc comment is a transcription of the Parquet Thrift IDL, and reads to be be calculated as follows. Upstream parquet-format's parquet.thrift reads to be calculated, so this is a transcription slip and the fix restores agreement with the spec.

Found by searching the tree for \b(\w+)\s+\1\b restricted to comment and prose lines. The remaining matches are ASCII-art layout diagrams in list_array.rs / list_view_array.rs (Logical Logical column headings) and correct English like 100-row row group; those are left alone.

What changes are included in this PR?

Removes 13 doubled words across 11 Rust files and 1 Markdown file. Comment and prose text only — no code changes.

File Fix
arrow-buffer/src/lib.rs Run-ends used in run-encoded encoded data
arrow-buffer/src/util/bit_chunk_iterator.rs and and an offset and length in bits
arrow-array/src/array/run_array.rs A RunArray typed typed on its child values array
arrow-data/src/data.rs 2. the the null count is correct
arrow-data/src/transform/mod.rs Note this this is not stored in _MutableArrayData
parquet/src/file/properties.rs default values for ndv and fpp value are used used
parquet/src/file/metadata/mod.rs (x2) Takes ownership of the the column metadata; Returns a reference to the the histogram's values
parquet/src/file/metadata/thrift/mod.rs CRC checksum for the page, to be be calculated
parquet/src/arrow/mod.rs the AES encryption keys required required for decrypting
parquet/src/arrow/arrow_reader/mod.rs maximum size of value to pass to to value generator
parquet/src/arrow/arrow_reader/statistics.rs extracting i128 values from from an iterator
parquet_derive/README.md You must must enable the chrono feature

Are these changes tested?

No new tests — the change is confined to comments and prose, so there is no behaviour to cover.

Checks run locally on Linux x86_64 with the pinned 1.98.1 toolchain:

  • typos --config typos.toml (v1.37.0, the version pinned in dev.yml) — pass

  • cargo fmt --all --check — pass

  • cargo test --doc -p arrow-buffer -p arrow-array -p arrow-data -p parquet --all-features — pass, 376 doctests, 0 failed (arrow-array 206, parquet 96, arrow-buffer 60, arrow-data 14)

    This first failed with 5 errors, all of them PARQUET_TEST_DATA is undefined from an uninitialised parquet-testing submodule rather than anything in this PR. The numbers above are from the re-run after git submodule update --init.

parquet_derive/README.md is outside the prettier glob in dev.yml ({arrow,arrow-flight,dev,arrow-integration-testing,parquet}/**/*.md), so the docs formatting job is unaffected.

I did not run the full test suite. One edited line sits inside a rustdoc example (parquet/src/arrow/mod.rs, the encryption example), and that doctest is covered by the run above; every other edited line is an ordinary comment.

Are there any user-facing changes?

No API or behaviour changes. The rendered rustdoc is corrected for RunEndBuffer, UnalignedBitChunk::new, Int64RunArray, ArrayData, WriterProperties, ColumnChunkMetaDataBuilder::take_column_metadata, Histogram::values, PageHeader, and two parquet::arrow reader items.


AI disclosure

This contribution was AI-assisted. Claude Code (Claude Opus 5) performed the tree-wide doubled-word search, made the 13 line edits, checked the PageHeader comment against upstream parquet-format, and ran every check listed above. The check commands were executed by the AI and have not been independently re-run by hand.

Removes thirteen accidentally doubled words across eleven Rust files and
one Markdown file: "run-encoded encoded", "and and an offset", "typed
typed on", "must must enable", "2. the the null count", "Note this
this", "are used used", "of the the column metadata", "to the the
histogram's", "to be be calculated", "required required for", "to pass
to to" and "from from an iterator". Comment and prose text only, with no
code changes.

The `PageHeader` case is a transcription slip rather than a faithful
copy: upstream parquet-format's parquet.thrift reads "to be calculated".

These survive CI because the typos checker matches misspelled words and
does not detect a correctly spelled word repeated twice in a row.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

@Jefffrey Jefffrey left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need such a verbose PR body for these simple fixes 😅

Comment thread arrow-buffer/src/util/bit_chunk_iterator.rs Outdated
@Jefffrey Jefffrey added the documentation Improvements or additions to documentation label Sep 9, 2026
Co-authored-by: Jeffrey Vo <jeffrey.vo.australia@gmail.com>
@github-actions github-actions Bot added parquet Changes to the parquet crate arrow Changes to the arrow crate parquet-derive parquet_derive crate arrow-data arrow-buffer arrow-array labels Sep 9, 2026

@Rich-T-kid Rich-T-kid left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

arrow Changes to the arrow crate arrow-array arrow-buffer arrow-data documentation Improvements or additions to documentation parquet Changes to the parquet crate parquet-derive parquet_derive crate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants