microsoft / microsoft/qdk

Reexports in Libraries are not properly Supported in the Doc Gen tool

Open
#1,993 0 comments 0 reactions 1 assignee View on GitHub

Nobody has claimed this yet.

bug documentation
Dominant language
Rust
Stars
1k
Forks
212
Avg merge
3d 8h
Merged PRs (30d)
65

Description

**Describe the bug**

The doc gen tool ignores several items that are reexported, and two items, `Micorosft.Quantum.Core.Length` and `Micorosft.Quantum.Core.Repeated` are generated with empty files. All items that are reexports should have their own doc file and that file should have a redirection link to the base definition for the item.

These items should also appear in the table of contents.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.