Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.
This repository was archived by the owner on Jan 12, 2024. It is now read-only.

Allow documenting named items of UDTs #113

@cgranade

Description

@cgranade

Is your feature request related to a problem? Please describe.
Recently, Q# gained support for UDTs with named items; e.g.: newtype Foo = (A: Int, (B: Bool, C: Qubit)). At the moment, these named items aren't surfaced through to API documentation, such that the names aren't easy to use.

Describe the solution you'd like

/// # Summary
/// ...
///
/// # Named Items
/// ## A
/// ...
/// ## B
/// ...
/// ## C
/// ...
newtype Foo = (A: Int, (B: Bool, C: Qubit))

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationfeatureNew feature to be added

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions