Skip to content

Links broken in ArrayRef documentation #1583

Description

@akern40

Links to documentation sections like Slicing used to work (and still do) for ArrayBase because the documentation was on the same page as the struct. Now ArrayRef's links are broken. We can fix them in the short term, or we can deploy #1499 and link to there.

Activity

  1. cschanhniem commented on Jun 19, 2026

    @cschanhniem

    I traced through the docs to find the specific broken links. The main issue is in the ArrayRef docs generated from the impl_ref_types.rs module — cross-references in methods inherited through Deref from ArrayBase resolve to anchors on the ArrayBase page (e.g., #slicing, #method.view) but the same links are broken when rendered on ArrayRef's own page.

    For example:

    • lib.rs:51 — [Slicing](ArrayBase#slicing) works on ArrayBase's page but the equivalent reference on any ArrayRef-scoped doc text doesn't resolve.
    • Any /// doc comment using intra-doc links like [ArrayRef::view] that also reference methods only defined on ArrayBase can render incorrectly.

    I can put together a PR that replaces these with canonical intra-doc links — e.g., replacing bare [Slicing] references with [ArrayBase::slice] or crate::ArrayBase#slicing as appropriate. Let me know if you'd like me to proceed.

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions