Skip to content

Tighten the docs and fix inaccurate claims - #1217

Open
quinnj wants to merge 2 commits into
mainfrom
claude/docs-pass
Open

quinnj wants to merge 2 commits into
mainfrom
claude/docs-pass

Conversation

@quinnj

@quinnj quinnj commented Oct 16, 2026 •

Copy link
Copy Markdown
Member

A pass over the manual pages, README, and public docstrings for accuracy and length.

Corrections (checked against main, and against CSV 0.10.16 for the migration guide):

  • Migration guide: 0.10 did not truncate date-time fractions; a column with more than three fraction digits stayed text. The table now says so and points to typemap=Dict(Timestamp{Nanosecond} => DateTime), which keeps that behavior.
  • Migration guide: adds the empty-field change (0.10 read "" as missing, 1.0 reads an empty string), the Boolean spellings 0.10 accepted (T/F inferred, 1/0 with types=Bool), and footerskip no longer counting comment rows.
  • Migration guide: 0.10 CSV.Rows buffered one row; 1.0 keeps an index of every row (about 4 bytes per field plus 8 per row, measured). CSV.Chunks rejects maxwarnings. 0.10 already promoted Int/Float across sources; the change is that a missing column is filled instead of throwing.
  • Writing: a partition base path "part.csv" writes part.csv_1, part.csv_2 (as in 0.10); the example shows that now.
  • CSV.LazyFile: text cells follow stringtype.
  • 1.0 release notes: drops the claim that typed row.name access did not allocate (fixed in 1.1.0) and the "no fraction digit is truncated" comparison.
  • The removed-debug error said "removed in 1.0" twice; debug and parsingdebug now point at CSV.problems.

Trims: implementation detail users don't act on (index geometry, scanner names, Int32 view offsets, lenient-rule mechanics, the Chunks pre-pass structure), change narration outside the migration guide and release notes, and repeated statements. CSV.write's docstring lists its keywords with defaults, like #1215 does for CSV.File. Jacob's original example comments are unchanged.

Overlap: no hunk overlaps #1210, #1212, #1213, #1215, or #1216; git merge-tree merges this branch cleanly with each. The tails of the CSV.lazy and CSV.Chunks docstrings still carry internals (view offsets, pre-pass details); I left them because #1215 edits those lines.

Verification: julia --project=docs docs/make.jl builds with doctests and no warnings; the full suite passes locally (331,778 tests, Julia 1.12.6, --check-bounds=yes -t4). Each changed claim was checked with a probe.

🤖 Generated with Claude Code

quinnj and others added 2 commits October 15, 2026 19:11
Fix claims that did not match the code, and cut internals and change
narration from the reading, writing, index, examples, migration, and
release-notes pages and the public docstrings.

Corrections, each checked with a probe on main and on CSV 0.10.16:
- migration: 0.10 left date-times with more than three fraction digits as
  text instead of truncating them; 0.10 read `""` as missing; 0.10 inferred
  T/F as Bool and read 1/0 for types=Bool; 0.10 counted comment rows in
  footerskip; 0.10 Rows buffered only the current row; CSV.Chunks rejects
  maxwarnings; 0.10 already promoted Int and Float across sources.
- writing: a partition base path "part.csv" writes "part.csv_1", ...
- LazyFile: text cells follow stringtype, not always DataString.
- 1.0 release notes: Rows typed access allocated until 1.1.0, and 0.10 did
  not truncate fractions.
- The removed `debug` keyword message said "removed in 1.0" twice and both
  debug messages pointed at a non-public index; point at CSV.problems.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@codecov

codecov Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.79%. Comparing base (2f84f42) to head (7ec0b51).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1217   +/-   ##
=======================================
  Coverage   95.79%   95.79%           
=======================================
  Files           9        9           
  Lines        5566     5566           
=======================================
  Hits         5332     5332           
  Misses        234      234           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

This branch has not been deployed

No deployments
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