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

Fix documentation warnings #353

Merged
github-actions merged 3 commits into from
Oct 21, 2020
Merged

Fix documentation warnings #353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d3d30a8
Fix warnings raised by new documentation generation tool.
cgranade Oct 16, 2020
55cab2c
Fix some API docs for ComplexPolar.
cgranade Oct 20, 2020
12c7e21
Update to 0.12.20102008-beta.
cgranade Oct 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions Build/props/tests.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,11 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.Quantum.Xunit" Version="0.12.20082515-beta" />
<PackageReference Include="Microsoft.Quantum.Xunit" Version="0.12.20102008-beta" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.4.0" />
<PackageReference Include="xunit" Version="2.4.1" />
<PackageReference Include="xunit.runner.visualstudio" Version="2.4.1" />
<DotNetCliToolReference Include="dotnet-xunit" Version="2.3.1" />
</ItemGroup>

</Project>

4 changes: 2 additions & 2 deletions Chemistry/src/Runtime/Runtime.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.Quantum.Sdk/0.12.20082515-beta">
<Project Sdk="Microsoft.Quantum.Sdk/0.12.20102008-beta">

<PropertyGroup>
<TargetFramework>netstandard2.1</TargetFramework>
Expand Down Expand Up @@ -40,7 +40,7 @@
</ItemGroup>

<ItemGroup>
<PackageReference Include="Microsoft.Quantum.Simulators" Version="0.12.20082515-beta" />
<PackageReference Include="Microsoft.Quantum.Simulators" Version="0.12.20102008-beta" />
</ItemGroup>

<ItemGroup>
Expand Down
3 changes: 1 addition & 2 deletions Chemistry/tests/ChemistryTests/QSharpTests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.Quantum.Sdk/0.12.20082515-beta">
<Project Sdk="Microsoft.Quantum.Sdk/0.12.20102008-beta">

<Import Project="..\..\..\Build\props\tests.props" />

Expand All @@ -12,4 +12,3 @@
</ItemGroup>

</Project>

3 changes: 1 addition & 2 deletions Chemistry/tests/SystemTests/SystemTests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.Quantum.Sdk/0.12.20082515-beta">
<Project Sdk="Microsoft.Quantum.Sdk/0.12.20102008-beta">

<Import Project="..\..\..\Build\props\tests.props" />

Expand Down Expand Up @@ -39,4 +39,3 @@
</ItemGroup>

</Project>

2 changes: 1 addition & 1 deletion MachineLearning/src/MachineLearning.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.Quantum.Sdk/0.12.20082515-beta">
<Project Sdk="Microsoft.Quantum.Sdk/0.12.20102008-beta">
<PropertyGroup>
<TargetFramework>netstandard2.1</TargetFramework>
<AssemblyName>Microsoft.Quantum.MachineLearning</AssemblyName>
Expand Down
2 changes: 1 addition & 1 deletion MachineLearning/tests/MachineLearningTests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.Quantum.Sdk/0.12.20082515-beta">
<Project Sdk="Microsoft.Quantum.Sdk/0.12.20102008-beta">

<Import Project="..\..\Build\props\tests.props" />

Expand Down
4 changes: 2 additions & 2 deletions Numerics/src/Numerics.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.Quantum.Sdk/0.12.20082515-beta">
<Project Sdk="Microsoft.Quantum.Sdk/0.12.20102008-beta">

<PropertyGroup>
<TargetFramework>netstandard2.1</TargetFramework>
Expand Down Expand Up @@ -41,7 +41,7 @@
</ItemGroup>

<ItemGroup>
<PackageReference Include="Microsoft.Quantum.Simulators" Version="0.12.20082515-beta" />
<PackageReference Include="Microsoft.Quantum.Simulators" Version="0.12.20102008-beta" />
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.0.0" PrivateAssets="All" />
</ItemGroup>

Expand Down
2 changes: 1 addition & 1 deletion Numerics/tests/NumericsTests.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<Project Sdk="Microsoft.Quantum.Sdk/0.12.20082515-beta">
<Project Sdk="Microsoft.Quantum.Sdk/0.12.20102008-beta">

<Import Project="..\..\Build\props\tests.props" />

Expand Down
8 changes: 1 addition & 7 deletions Standard/src/AmplitudeAmplification/AmplitudeAmplification.qs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,6 @@ namespace Microsoft.Quantum.AmplitudeAmplification {
/// Reflection operator about start state
/// ## targetStateReflection
/// Reflection operator about target state
/// ## startQubits
/// Qubit register
///
/// # Output
/// An operation that implements amplitude amplification by partial reflections.
Expand Down Expand Up @@ -223,8 +221,6 @@ namespace Microsoft.Quantum.AmplitudeAmplification {
/// Unitary oracle $A$ that prepares start state
/// ## idxFlagQubit
/// Index to flag qubit
/// ## qubits
/// Start state register
///
/// # Output
/// An operation that implements amplitude amplification by oracles that are
Expand Down Expand Up @@ -259,12 +255,10 @@ namespace Microsoft.Quantum.AmplitudeAmplification {
/// # Input
/// ## nIterations
/// Number of iterations $n$ of amplitude amplification
/// ## statePrepOracle
/// ## stateOracle
/// Unitary oracle $A$ that prepares start state
/// ## idxFlagQubit
/// Index to flag qubit
/// ## qubits
/// Start state register
///
/// # Output
/// An operation that implements the standard amplitude amplification quantum algorithm
Expand Down
6 changes: 3 additions & 3 deletions Standard/src/Arithmetic/ApplyDual.qs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ namespace Microsoft.Quantum.Arithmetic {
}

/// # See Also
/// - ApplyPhaseLEOperationOnLE
/// - Microsoft.Quantum.Canon.ApplyPhaseLEOperationOnLE
operation ApplyPhaseLEOperationOnLEA (op : (PhaseLittleEndian => Unit is Adj), target : LittleEndian) : Unit
{
body (...)
Expand All @@ -53,7 +53,7 @@ namespace Microsoft.Quantum.Arithmetic {


/// # See Also
/// - @"microsoft.quantum.canon.applyphaseleoperationonle"
/// - Microsoft.Quantum.Canon.ApplyPhaseLEOperationOnLE
operation ApplyPhaseLEOperationOnLEC (op : (PhaseLittleEndian => Unit is Ctl), target : LittleEndian) : Unit
{
body (...)
Expand All @@ -75,7 +75,7 @@ namespace Microsoft.Quantum.Arithmetic {


/// # See Also
/// - @"microsoft.quantum.canon.applyphaseleoperationonle"
/// - Microsoft.Quantum.Canon.ApplyPhaseLEOperationOnLE
operation ApplyPhaseLEOperationOnLECA (op : (PhaseLittleEndian => Unit is Adj + Ctl), target : LittleEndian) : Unit
{
body (...)
Expand Down
114 changes: 57 additions & 57 deletions Standard/src/Arithmetic/ApplyReversed.qs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

///////////////////////////////////////////////////////////////////////////////////////////
Expand All @@ -20,9 +20,9 @@ namespace Microsoft.Quantum.Arithmetic {
/// A big-endian register to be transformed.
///
/// # See Also
/// - ApplyReversedOpLEA
/// - ApplyReversedOpLEC
/// - ApplyReversedOpLECA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpLEA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpLEC
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpLECA
operation ApplyReversedOpLE(op : (LittleEndian => Unit), register : BigEndian) : Unit {
ApplyWithInputTransformation(BigEndianAsLittleEndian, op, register);
}
Expand All @@ -38,10 +38,10 @@ namespace Microsoft.Quantum.Arithmetic {
/// A new operation that accepts its input as a big-endian register.
///
/// # See Also
/// - ApplyReversedOpLE
/// - ReversedOpLEA
/// - ReversedOpLEC
/// - ReversedOpLECA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpLE
/// - Microsoft.Quantum.Arithmetic.ReversedOpLEA
/// - Microsoft.Quantum.Arithmetic.ReversedOpLEC
/// - Microsoft.Quantum.Arithmetic.ReversedOpLECA
function ReversedOpLE(op : (LittleEndian => Unit)) : (BigEndian => Unit) {
return ApplyReversedOpLE(op, _);
}
Expand All @@ -57,9 +57,9 @@ namespace Microsoft.Quantum.Arithmetic {
/// A big-endian register to be transformed.
///
/// # See Also
/// - ApplyReversedOpLE
/// - ApplyReversedOpLEC
/// - ApplyReversedOpLECA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpLE
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpLEC
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpLECA
operation ApplyReversedOpLEA (op : (LittleEndian => Unit is Adj), register : BigEndian) : Unit {
body (...) {
ApplyWithInputTransformationA(BigEndianAsLittleEndian, op, register);
Expand All @@ -81,10 +81,10 @@ namespace Microsoft.Quantum.Arithmetic {
/// A new operation that accepts its input as a big-endian register.
///
/// # See Also
/// - ApplyReversedOpLEA
/// - ReversedOpLE
/// - ReversedOpLEC
/// - ReversedOpLECA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpLEA
/// - Microsoft.Quantum.Arithmetic.ReversedOpLE
/// - Microsoft.Quantum.Arithmetic.ReversedOpLEC
/// - Microsoft.Quantum.Arithmetic.ReversedOpLECA
function ReversedOpLEA(op : (LittleEndian => Unit is Adj)) : (BigEndian => Unit is Adj) {
return ApplyReversedOpLEA(op, _);
}
Expand All @@ -100,9 +100,9 @@ namespace Microsoft.Quantum.Arithmetic {
/// A big-endian register to be transformed.
///
/// # See Also
/// - ApplyReversedOpLE
/// - ApplyReversedOpLEA
/// - ApplyReversedOpLECA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpLE
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpLEA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpLECA
operation ApplyReversedOpLEC(op : (LittleEndian => Unit is Ctl), register : BigEndian) : Unit {
body (...) {
ApplyWithInputTransformationC(BigEndianAsLittleEndian, op, register);
Expand All @@ -123,10 +123,10 @@ namespace Microsoft.Quantum.Arithmetic {
/// A new operation that accepts its input as a big-endian register.
///
/// # See Also
/// - ApplyReversedOpLEC
/// - ReversedOpLE
/// - ReversedOpLEA
/// - ReversedOpLECA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpLEC
/// - Microsoft.Quantum.Arithmetic.ReversedOpLE
/// - Microsoft.Quantum.Arithmetic.ReversedOpLEA
/// - Microsoft.Quantum.Arithmetic.ReversedOpLECA
function ReversedOpLEC(op : (LittleEndian => Unit is Ctl)) : (BigEndian => Unit is Ctl) {
return ApplyReversedOpLEC(op, _);
}
Expand All @@ -142,9 +142,9 @@ namespace Microsoft.Quantum.Arithmetic {
/// A big-endian register to be transformed.
///
/// # See Also
/// - ApplyReversedOpLE
/// - ApplyReversedOpLEA
/// - ApplyReversedOpLEC
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpLE
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpLEA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpLEC
operation ApplyReversedOpLECA(op : (LittleEndian => Unit is Ctl + Adj), register : BigEndian) : Unit {
body (...) {
ApplyWithInputTransformationCA(BigEndianAsLittleEndian, op, register);
Expand All @@ -167,10 +167,10 @@ namespace Microsoft.Quantum.Arithmetic {
/// A new operation that accepts its input as a big-endian register.
///
/// # See Also
/// - ApplyReversedOpLECA
/// - ReversedOpLE
/// - ReversedOpLEA
/// - ReversedOpLEC
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpLECA
/// - Microsoft.Quantum.Arithmetic.ReversedOpLE
/// - Microsoft.Quantum.Arithmetic.ReversedOpLEA
/// - Microsoft.Quantum.Arithmetic.ReversedOpLEC
function ReversedOpLECA(op : (LittleEndian => Unit is Adj + Ctl)) : (BigEndian => Unit is Adj + Ctl) {
return ApplyReversedOpLECA(op, _);
}
Expand All @@ -186,9 +186,9 @@ namespace Microsoft.Quantum.Arithmetic {
/// A little-endian register to be transformed.
///
/// # See Also
/// - ApplyReversedOpBEA
/// - ApplyReversedOpBEC
/// - ApplyReversedOpBECA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpBEA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpBEC
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpBECA
operation ApplyReversedOpBE(op : (BigEndian => Unit), register : LittleEndian) : Unit {
ApplyWithInputTransformation(LittleEndianAsBigEndian, op, register);
}
Expand All @@ -205,10 +205,10 @@ namespace Microsoft.Quantum.Arithmetic {
/// A new operation that accepts its input as a little-endian register.
///
/// # See Also
/// - ApplyReversedOpBE
/// - ReversedOpBEA
/// - ReversedOpBEC
/// - ReversedOpBECA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpBE
/// - Microsoft.Quantum.Arithmetic.ReversedOpBEA
/// - Microsoft.Quantum.Arithmetic.ReversedOpBEC
/// - Microsoft.Quantum.Arithmetic.ReversedOpBECA
function ReversedOpBE(op : (BigEndian => Unit)) : (LittleEndian => Unit) {
return ApplyReversedOpBE(op, _);
}
Expand All @@ -224,9 +224,9 @@ namespace Microsoft.Quantum.Arithmetic {
/// A little-endian register to be transformed.
///
/// # See Also
/// - ApplyReversedOpBE
/// - ApplyReversedOpBEC
/// - ApplyReversedOpBECA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpBE
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpBEC
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpBECA
operation ApplyReversedOpBEA (op : (BigEndian => Unit is Adj), register : LittleEndian) : Unit {
body (...) {
ApplyWithInputTransformationA(LittleEndianAsBigEndian, op, register);
Expand All @@ -247,10 +247,10 @@ namespace Microsoft.Quantum.Arithmetic {
/// A new operation that accepts its input as a little-endian register.
///
/// # See Also
/// - ApplyReversedOpBEA
/// - ReversedOpBE
/// - ReversedOpBEC
/// - ReversedOpBECA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpBEA
/// - Microsoft.Quantum.Arithmetic.ReversedOpBE
/// - Microsoft.Quantum.Arithmetic.ReversedOpBEC
/// - Microsoft.Quantum.Arithmetic.ReversedOpBECA
function ReversedOpBEA(op : (BigEndian => Unit is Adj)) : (LittleEndian => Unit is Adj) {
return ApplyReversedOpBEA(op, _);
}
Expand All @@ -266,9 +266,9 @@ namespace Microsoft.Quantum.Arithmetic {
/// A little-endian register to be transformed.
///
/// # See Also
/// - ApplyReversedOpBE
/// - ApplyReversedOpBEA
/// - ApplyReversedOpBECA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpBE
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpBEA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpBECA
operation ApplyReversedOpBEC(op : (BigEndian => Unit is Ctl), register : LittleEndian) : Unit {
body (...) {
ApplyWithInputTransformationC(LittleEndianAsBigEndian, op, register);
Expand All @@ -289,10 +289,10 @@ namespace Microsoft.Quantum.Arithmetic {
/// A new operation that accepts its input as a little-endian register.
///
/// # See Also
/// - ApplyReversedOpBEC
/// - ReversedOpBE
/// - ReversedOpBEA
/// - ReversedOpBECA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpBEC
/// - Microsoft.Quantum.Arithmetic.ReversedOpBE
/// - Microsoft.Quantum.Arithmetic.ReversedOpBEA
/// - Microsoft.Quantum.Arithmetic.ReversedOpBECA
function ReversedOpBEC(op : (BigEndian => Unit is Ctl)) : (LittleEndian => Unit is Ctl) {
return ApplyReversedOpBEC(op, _);
}
Expand All @@ -308,9 +308,9 @@ namespace Microsoft.Quantum.Arithmetic {
/// A little-endian register to be transformed.
///
/// # See Also
/// - ApplyReversedOpBE
/// - ApplyReversedOpBEA
/// - ApplyReversedOpBEC
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpBE
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpBEA
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpBEC
operation ApplyReversedOpBECA(op : (BigEndian => Unit is Ctl + Adj), register : LittleEndian) : Unit {
body (...) {
ApplyWithInputTransformationCA(LittleEndianAsBigEndian, op, register);
Expand All @@ -333,10 +333,10 @@ namespace Microsoft.Quantum.Arithmetic {
/// A new operation that accepts its input as a little-endian register.
///
/// # See Also
/// - ApplyReversedOpBECA
/// - ReversedOpBE
/// - ReversedOpBEA
/// - ReversedOpBEC
/// - Microsoft.Quantum.Arithmetic.ApplyReversedOpBECA
/// - Microsoft.Quantum.Arithmetic.ReversedOpBE
/// - Microsoft.Quantum.Arithmetic.ReversedOpBEA
/// - Microsoft.Quantum.Arithmetic.ReversedOpBEC
function ReversedOpBECA(op : (BigEndian => Unit is Adj + Ctl)) : (LittleEndian => Unit is Adj + Ctl) {
return ApplyReversedOpBECA(op, _);
}
Expand Down
2 changes: 1 addition & 1 deletion Standard/src/Arithmetic/Arithmetic.qs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ namespace Microsoft.Quantum.Arithmetic {
/// in computational basis.
///
/// # See Also
/// - LittleEndian
/// - Microsoft.Quantum.Arithmetic.LittleEndian
operation CopyMostSignificantBit (from : LittleEndian, target : Qubit) : Unit {
body (...) {
let mostSingificantQubit = Tail(from!);
Expand Down
4 changes: 2 additions & 2 deletions Standard/src/Arithmetic/Comparators.qs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (c) Microsoft Corporation. All rights reserved.
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

namespace Microsoft.Quantum.Arithmetic {
Expand Down Expand Up @@ -48,7 +48,7 @@ namespace Microsoft.Quantum.Arithmetic {
ApplyToEachCA(X, x! + [auxiliary]);

ApplyMajorityInPlace(x![0], [y![0], auxiliary]);
ApplyToEachCA(MAJ, Zip3(Most(x!), Rest(y!), Rest(x!)));
ApplyToEachCA(MAJ, Zipped3(Most(x!), Rest(y!), Rest(x!)));
} apply {
X(output);
CNOT(Tail(x!), output);
Expand Down
Loading