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

Add metadata needed for improved documentation generation#342

Merged
github-actions[bot] merged 5 commits intofeature/docgenfrom
cgranade/experimental/docgen
Oct 7, 2020
Merged

Add metadata needed for improved documentation generation#342
github-actions[bot] merged 5 commits intofeature/docgenfrom
cgranade/experimental/docgen

Conversation

@cgranade
Copy link
Contributor

@cgranade cgranade commented Oct 7, 2020

This PR adds package names to documentation metadata, adapts C# magic command implementations to resolve the ambiguity between Documentation from the Microsoft.Quantum.* and Microsoft.Jupyter.Core namespaces, and adds /// # Named Items sections. See microsoft/qsharp-compiler#594 for additional context and discussion.

@cgranade cgranade requested review from anpaz, guenp and msoeken October 7, 2020 06:38
Copy link
Member

@msoeken msoeken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @cgranade. One change looked a bit odd, and I commented it. Otherwise good to go.

@cgranade cgranade added the automerge Pull request is ready to be automatically merged, pending checks and reviews. label Oct 7, 2020
@cgranade
Copy link
Contributor Author

cgranade commented Oct 7, 2020

/AzurePipelines run

@azure-pipelines
Copy link

No pipelines are associated with this pull request.

@cgranade
Copy link
Contributor Author

cgranade commented Oct 7, 2020

/AzurePipelines run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 2 pipeline(s).

@github-actions github-actions bot merged commit b68f5dd into feature/docgen Oct 7, 2020
@github-actions github-actions bot deleted the cgranade/experimental/docgen branch October 7, 2020 20:28
cgranade pushed a commit that referenced this pull request Oct 21, 2020
* Add metadata needed for improved documentation generation (#342)

* Fix documentation warnings (#353)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

automerge Pull request is ready to be automatically merged, pending checks and reviews.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants