Skip to content
#

quantum-development-kit

Here are 20 public repositories matching this topic...

samarsha
samarsha commented Oct 22, 2020

Most documentation comments in the compiler only use the <summary> tag. For short comments, this is fine, but in many cases the summary is several paragraphs long and would be easier to read if it used standard documentation tags to structure the information. This is especially important for exceptions - exceptions mentioned in the <summary> tag are easy to miss, whereas the special `<exceptio

bug documentation help wanted good first issue
cgranade
cgranade commented Oct 2, 2020

Is your feature request related to a problem? Please describe.
Adding concrete examples to API documentation comments can help clarify how Q# functions and operations are to be used. For example, the documentation for Microsoft.Quantum.Arrays.ElementsAt lists how the function acts on a variety of arrays:

Kind-Enhancement good first issue Area-Documentation Hacktoberfest

Improve this page

Add a description, image, and links to the quantum-development-kit topic page so that developers can more easily learn about it.

Curate this topic

Add this topic to your repo

To associate your repository with the quantum-development-kit topic, visit your repo's landing page and select "manage topics."

Learn more