Skip to content

stdlib doc-comment style mix: array.nx/str.nx/result.nx interleave /// and /** */ for per-function docs #637

@Nymphium

Description

@Nymphium

After the nexus-xqzl deletion sweep, audit confirmed no stale /// references in nxlib/stdlib/*.nx — all cited symbols (e.g. get_byte_unchecked, parse_f64_checked, get_field, oneshot/recv, Fs.exists, alloc.mark/reset, respond_streaming_write/finish) still exist. The cleanup commit cf5894a already pruned skills/ references.

What remains is a style inconsistency that the deletions left more visible:

  • list.nx: uniformly /** ... */ for module + per-function docs (11 blocks).
  • array.nx: mixes 4 per-function /** */ blocks (fold_left L59, filter L121, partition L148, consume L169) with /// elsewhere (any L82, all L101, length, get, set, etc.).
  • str.nx: 1 module /** / + 1 per-function /* */ on split (L119) while every other entry uses ///.
  • result.nx: 1 module /** / + 1 per-function /* */ on and_then (L45) while the rest use ///.
  • All other 25 stdlib files: /// for entry docs, /** */ only for the module banner (or no module banner).

Two valid resolutions:
(a) normalize per-function docs to /// across array.nx/str.nx/result.nx (matches the 25-file majority);
(b) normalize per-function docs to /** */ across stdlib (matches list.nx).

Pick one and apply consistently. Either is fine; the current mix is the bug.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions