Skip to content

Tidy docs: install line, CI matrix, changelog, docstring wording - #5

Open
quinnj wants to merge 1 commit into
mainfrom
claude/docs-cleanup
Open

quinnj wants to merge 1 commit into
mainfrom
claude/docs-cleanup

Conversation

@quinnj

@quinnj quinnj commented Oct 16, 2026

Copy link
Copy Markdown
Member

Small accuracy and wording fixes; no code changes.

  • README: drop "After registration" from the install line (DataStrings 1.1.0 is registered). Describe the CI matrix as it runs: 1.10 and current stable on Linux, Windows, and macOS; 1.11 and the latest prerelease (pre, not nightly) on Linux.
  • Module docstring: the byte-for-byte Arrow StringView claim holds on little-endian hosts, as the README already says. Drop the all-caps emphasis and fix "an DataString" left from the ArrowStrings rename (also in the StringVector/BytesVector docstrings).
  • CHANGELOG: add the missing 1.1.0 entry (convert(DataBytes, ...), materialize on plain vectors, Add convert to DataBytes and materialize for plain vectors of values #2), and an Unreleased entry for the encoding fix in Normalize string encodings before column edits #3, which is on main but not in a release.

Verified the unchanged claims with probes:

  • Read operations (hash, cmp, ==, isless, iteration, codeunit, length) allocate zero bytes on 1.10.11 and 1.12.6.
  • Equality, hashing, ordering, indexing, and iteration match String on all 139,810 byte sequences of length 0-4 drawn from 16 UTF-8 class-boundary bytes, inline and as views, on 1.10, 1.12, and 1.13.
  • DataBytes equality and hashing match Vector{UInt8}.

Pkg.test() passes on Julia 1.10.11 and 1.12.6.

🤖 Generated with Claude Code

The README still said "after registration" and described the CI matrix
as nightly on every OS; CI runs 1.10 and stable on three OSes and 1.11
and the latest prerelease on Linux. The module docstring now qualifies
the byte-for-byte Arrow claim to little-endian hosts, as the README
does, and drops all-caps emphasis and "an `DataString`" left from the
rename. The changelog gains the 1.1.0 entry and the unreleased
encoding fix from #3.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant