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

Allow documenting named items of UDTs #113

Closed
cgranade opened this issue Aug 14, 2019 · 3 comments
Closed

Allow documenting named items of UDTs #113

cgranade opened this issue Aug 14, 2019 · 3 comments
Labels
documentation Improvements or additions to documentation feature New feature to be added

Comments

@cgranade
Copy link
Contributor

cgranade commented Aug 14, 2019

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))
@cgranade cgranade added the enhancement New request or suggestion for an improvement label Aug 14, 2019
@bettinaheim
Copy link
Contributor

bettinaheim commented Aug 14, 2019

The only support that is needed here is in the docs parser, as long as this fits into the scheme. @cgranade Do you want to take this one? :)

@bettinaheim bettinaheim added feature New feature to be added documentation Improvements or additions to documentation labels Aug 14, 2019
@bettinaheim
Copy link
Contributor

Looks like this does not fit into our current OPS scheme. We will need support there before we can address this. @natke could you look into this?

@bettinaheim
Copy link
Contributor

@cgranade I believe this should be addressed by the new code gen tool. Please reopen this and clarify if it isn't.

@bamarsha bamarsha removed the enhancement New request or suggestion for an improvement label Feb 12, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation feature New feature to be added
Projects
None yet
Development

No branches or pull requests

3 participants