Skip to content

Improve overload-set documentation #1094

@alandefreitas

Description

@alandefreitas

Overload pages list signatures and merged parameters, but lack a structured narrative. Readers cannot easily tell how overloads differ.

Proposed solution

  • Investigate strategies such as (a) common paragraphs plus numbered overload-specific notes, (b) selecting a base overload and layering differences, or (c) dedicated commands in the markup.
  • Prototype configuration options so projects can pick the strategy they prefer.
  • Update post-processing steps to support the chosen strategy.
  • Consider parser work to detect common paragraphs automatically.

Requirements

  • Document the proposed strategy with examples.
  • Implementation plan identified (including template changes).
  • Tests cover at least one overload set using the new behavior.

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