search

microsoft / qsharp-compiler

Q# compiler, command line tool, and Q# language server
https://docs.microsoft.com/quantum
MIT License
682 stars 171 forks source link

UDT named items not present in reference documentation "Syntax" block #277

Open cgranade opened 4 years ago

cgranade commented 4 years ago

Describe the bug

The syntax block in reference documentation for UDTs does not include named items, instead providing the declaration of a UDT that can only be used by unwrapping.

Screenshots

The reference documentation for Microsoft.Quantum.Math.Complex does not agree with its declaration as newtype Complex = (Real: Double, Imag: Double) in the runtime source file Math/Types.qs.

image

Additional context

This is related to but distinct from #113 in that this issue prevents the syntax block from appearing correctly, while #113 tracks the ability to provide additional information about named items in a fashion similar to inputs.

bettinaheim commented 4 years ago

@cgranade It may make more sense to tack this on docs, since I believe we will need an addition/change to our scheme to support docs for named items. Or did you have a solution within the current scheme in mind?

cgranade commented 4 years ago

I believe this one is a bug with how we currently populate the syntax field of our output YAML. If so, then this is under our control, by contrast with #113.

bettinaheim commented 4 years ago

@cgranade Do you want to pick it up then?