Skip to content

Commit c84896c

Browse files
committed
Fix docs links and Python doctest golden sizes for edition-gated writer
- Qualify the DEFAULT_WRITE_EDITIONS intra-doc link in the editions module docs: links in the module's inner docs resolve at the facade's `pub mod` site, so unqualified links break rustdoc under -D warnings. Also move the stray "Logical Vortex data types." doc line back onto the dtype module. - Update the file-size golden values in the Python write-options doctests: the writer's pre-populated ArrayContext is now seeded from the session's enabled editions, which changes the footer's encoding list and shrinks the written files by 40 bytes. Signed-off-by: Claude <noreply@anthropic.com> Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CK2nCuXnyd2g3mNHQC8Lz2
1 parent 2da25df commit c84896c

3 files changed

Lines changed: 4 additions & 4 deletions

File tree

vortex-python/src/io.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ impl PyVortexWriteOptions {
258258
/// >>> vx.io.VortexWriteOptions.default().write(sprl, "chonky.vortex")
259259
/// >>> import os
260260
/// >>> os.path.getsize('chonky.vortex')
261-
/// 215940
261+
/// 215900
262262
///
263263
/// Wow, Vortex manages to use about two bytes per integer! So advanced. So tiny.
264264
///
@@ -268,7 +268,7 @@ impl PyVortexWriteOptions {
268268
///
269269
/// >>> vx.io.VortexWriteOptions.compact().write(sprl, "tiny.vortex")
270270
/// >>> os.path.getsize('tiny.vortex')
271-
/// 55068
271+
/// 55028
272272
///
273273
/// Random numbers are not (usually) composed of random bytes!
274274
#[staticmethod]

vortex/src/editions/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
//! variable, and the test harness; the actual declarations live here, one module per edition
88
//! (`editions::<family>::<date>`), and are seeded into the default session by
99
//! [`crate::editions::register_default_editions`], which also enables
10-
//! [`DEFAULT_WRITE_EDITIONS`] as the session's write target.
10+
//! [`crate::editions::DEFAULT_WRITE_EDITIONS`] as the session's write target.
1111
//!
1212
//! Each edition module declares the edition together with the encodings that join the
1313
//! family at it; members of earlier editions are inherited and never restated. Correctness

vortex/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,10 +145,10 @@ pub mod compressor {
145145
pub use vortex_btrblocks::SchemeId;
146146
}
147147

148-
/// Logical Vortex data types.
149148
/// Vortex editions: named, frozen sets of encodings with a read-compatibility guarantee.
150149
pub mod editions;
151150

151+
/// Logical Vortex data types.
152152
pub mod dtype {
153153
pub use vortex_array::dtype::*;
154154
}

0 commit comments

Comments
 (0)