Skip to content

Add API doc summaries for namespaces #1823

@tcNickolas

Description

@tcNickolas

Is your feature request related to a problem? Please describe.
We used to have namespace summaries that included the tables of operations/functions/UDTs defined by that namespace and their one-sentence summaries (the first element of their API docs). https://learn.microsoft.com/en-us/qsharp/api/qsharp/microsoft.quantum.arrays is an example URL (redirects elsewhere now).

These were very useful for somebody trying to figure out whether a certain functionality exists within a library, for example, a certain array manipulation logic, but not knowing how exactly it is called. Now, one can only scroll the list of names, and to get the idea of what the operation does they need to go to the specific operation page. This is inconvenient.

Describe the solution you'd like
Return namespace summary doc pages.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions