MicrosoftDocs / quantum-api

Creative Commons Attribution 4.0 International
9 stars 16 forks source link

Reference docs for 0.27.244707. #86

Closed kuzminrobin closed 1 year ago

kuzminrobin commented 1 year ago

⚠ NOTE: This repository only contains automatically generated API documentation, and thus cannot accept pull requests. If you would like to contribute to the API documentation in this repo, please see the Quantum Development Kit contribution guide to learn more.

opbld30 commented 1 year ago

Learn Build status updates of commit fc6cbe2:

:warning: Validation status: warnings

File Status Preview URL Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampampbyoracle.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampampbyoraclephases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampampbyreflectionphases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampampobliviousbyoraclephases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampampobliviousbyreflectionphases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampampphasesfixedpoint.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampampphasesstandard.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampamprotationtoreflectionphases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.ampamprusbyoracle.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.amplitudeamplificationfrompartialreflections.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.amplitudeamplificationfromstatepreparation.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.applyamplitudeamplification.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.applyfixedpointamplification.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.applyobliviousamplitudeamplification.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.fixedpointreflectionphases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.obliviousamplitudeamplificationfrompartialreflections.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.obliviousamplitudeamplificationfromstatepreparation.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.reflectionphases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.reflectionstart.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.rotationphases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.rotationphasesasreflectionphases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.standardamplitudeamplification.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.standardreflectionphases.md :warning:Warning View Details
api/qsharp/microsoft.quantum.amplitudeamplification.targetstatereflectionoracle.md :warning:Warning View Details

This comment lists only the first 25 files in the pull request.

api/qsharp/microsoft.quantum.amplitudeamplification.ampampbyoracle.md

api/qsharp/microsoft.quantum.amplitudeamplification.ampampbyoraclephases.md

api/qsharp/microsoft.quantum.amplitudeamplification.ampampbyreflectionphases.md

api/qsharp/microsoft.quantum.amplitudeamplification.ampampobliviousbyoraclephases.md

api/qsharp/microsoft.quantum.amplitudeamplification.ampampobliviousbyreflectionphases.md

api/qsharp/microsoft.quantum.amplitudeamplification.ampampphasesfixedpoint.md

api/qsharp/microsoft.quantum.amplitudeamplification.ampampphasesstandard.md

This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request. For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Learn Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

kuzminrobin commented 1 year ago

Cassandra used to own those - I'm not sure where they are.

@Bradben, FYI, unfortunately Cassandra is not a part of the team any more.

kuzminrobin commented 1 year ago

@tedhudek, @Bradben, For context, this PR is a part of the monthly QDK Release process. Previously the reviewers were internal to the QDK dev team, but after a recent change some of the reviewers are not in the team any more.

So I decided to add someone from the Docs team to the review. Another reason is that the PR has numerous warnings (for a number of months). I remember the Docs team was working on similar warnings recently in the other repos. I wanted someone from the Docs team to have those warnings in mind. Maybe the Docs team has a common recommended approach to resolving those warnings.

Bradben commented 1 year ago

@kuzminrobin - if we can fix the metadata creation in the auto-gen process, I'm sure at least 99% of those warnings will disappear. The date, for instance, just needs to include leading zeros. If someone on your team can locate the source files for the process, I can probably figure it out.

kuzminrobin commented 1 year ago

If someone on your team can locate the source files for the process, I can probably figure it out.

@Bradben, Do you mean that you need a list of the file paths to run through an automated tool? If yes then that will likely be all the .md files in the repo (in Linux/WSL a command something like find . -name "*.md" to get a list of all the file paths; find . -name "*.md" -exec <YourTool> \{} \; to get a list of all the files and execute a tool for every file ).