Skip to content

Commit aae3eae

Browse files
clauderobert3005
authored andcommitted
docs(vortex-array): unlink private Interleave::check from public constructor docs
The `new_unchecked` / `new_unchecked_slots` doc comments intra-doc-linked `[`Interleave::check`]`, a private item, failing `rustdoc::private_intra_doc_links` (`-D warnings`). Drop the link brackets, keeping the inline-code reference. Signed-off-by: Joe Isaacs <joe.isaacs@live.co.uk>
1 parent ccda647 commit aae3eae

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

  • vortex-array/src/arrays/interleave

vortex-array/src/arrays/interleave/mod.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -223,15 +223,15 @@ impl Array<Interleave> {
223223
///
224224
/// This is the assembly half of [`try_new`](Self::try_new): it lays the selectors into
225225
/// `slots[0]`/`slots[1]` and the values into `slots[2..]` and stamps `dtype`, skipping the
226-
/// [`Interleave::check`] pass. It exists for hot internal paths — notably building the
226+
/// `Interleave::check` pass. It exists for hot internal paths — notably building the
227227
/// pushed-down validity interleave in [`ValidityVTable::validity`] — where the inputs are known
228228
/// to satisfy the invariants by construction and re-checking them is pure overhead.
229229
///
230230
/// # Safety
231231
///
232232
/// The caller must uphold every [module invariant](self): at least two `values` sharing a dtype
233233
/// up to nullability, both selectors non-nullable unsigned integers of equal length, and `dtype`
234-
/// equal to the value returned by [`Interleave::check`] for these arguments (the shared value
234+
/// equal to the value returned by `Interleave::check` for these arguments (the shared value
235235
/// type with the union of the values' nullabilities).
236236
pub unsafe fn new_unchecked(
237237
values: Vec<ArrayRef>,
@@ -262,7 +262,7 @@ impl Array<Interleave> {
262262
/// The caller must uphold every [module invariant](self) *and* the slot layout: `slots[0]` is
263263
/// the `array_indices` selector, `slots[1]` is the `row_indices` selector, and `slots[2..]` are
264264
/// the value arrays. Every slot must be `Some`, there must be at least two values
265-
/// (`slots.len() >= 4`), and `dtype` must equal the value returned by [`Interleave::check`] for
265+
/// (`slots.len() >= 4`), and `dtype` must equal the value returned by `Interleave::check` for
266266
/// these arguments.
267267
pub unsafe fn new_unchecked_slots(slots: ArraySlots, dtype: DType) -> Self {
268268
let num_values = slots.len() - 2;

0 commit comments

Comments
 (0)