From b68f5ddc39842fcae6c978ba238716ba68a53681 Mon Sep 17 00:00:00 2001 From: Chris Granade Date: Wed, 7 Oct 2020 13:28:34 -0700 Subject: [PATCH 1/2] Add metadata needed for improved documentation generation (#342) --- Chemistry/src/Jupyter/BroombridgeMagic.cs | 2 +- Chemistry/src/Jupyter/ChemistryEncodeMagic.cs | 2 +- Chemistry/src/Jupyter/FermionHamiltonianMagic.cs | 7 +++++-- Chemistry/src/Jupyter/WavefunctionMagic.cs | 2 +- Chemistry/src/Runtime/Runtime.csproj | 5 ++++- MachineLearning/src/MachineLearning.csproj | 1 + MachineLearning/src/Types.qs | 12 ++++++------ Numerics/src/Numerics.csproj | 2 +- Standard/src/AmplitudeAmplification/Types.qs | 11 ++++++++--- Standard/src/Math/Complex.qs | 6 +++--- Standard/src/Math/Types.qs | 12 ++++++++++++ Standard/src/Optimization/Univariate.qs | 2 +- 12 files changed, 44 insertions(+), 20 deletions(-) diff --git a/Chemistry/src/Jupyter/BroombridgeMagic.cs b/Chemistry/src/Jupyter/BroombridgeMagic.cs index abf5f8f5340..d3bbcc3bf9d 100644 --- a/Chemistry/src/Jupyter/BroombridgeMagic.cs +++ b/Chemistry/src/Jupyter/BroombridgeMagic.cs @@ -16,7 +16,7 @@ public class BroombridgeMagic : MagicSymbol public BroombridgeMagic() { this.Name = $"%chemistry.broombridge"; - this.Documentation = new Documentation() { Summary = "Loads and returns Broombridge electronic structure problem representation from a given .yaml file." }; + this.Documentation = new Microsoft.Jupyter.Core.Documentation() { Summary = "Loads and returns Broombridge electronic structure problem representation from a given .yaml file." }; this.Kind = SymbolKind.Magic; this.Execute = this.Run; } diff --git a/Chemistry/src/Jupyter/ChemistryEncodeMagic.cs b/Chemistry/src/Jupyter/ChemistryEncodeMagic.cs index 8eac3a69ca3..6e88be2b0be 100644 --- a/Chemistry/src/Jupyter/ChemistryEncodeMagic.cs +++ b/Chemistry/src/Jupyter/ChemistryEncodeMagic.cs @@ -17,7 +17,7 @@ public class ChemistryEncodeMagic : MagicSymbol public ChemistryEncodeMagic() { this.Name = $"%chemistry.encode"; - this.Documentation = new Documentation() { Summary = "Encodes a fermion Hamiltonian to a format consumable by Q#." }; + this.Documentation = new Microsoft.Jupyter.Core.Documentation() { Summary = "Encodes a fermion Hamiltonian to a format consumable by Q#." }; this.Kind = SymbolKind.Magic; this.Execute = this.Run; } diff --git a/Chemistry/src/Jupyter/FermionHamiltonianMagic.cs b/Chemistry/src/Jupyter/FermionHamiltonianMagic.cs index b61954ed4e0..07e3583bd37 100644 --- a/Chemistry/src/Jupyter/FermionHamiltonianMagic.cs +++ b/Chemistry/src/Jupyter/FermionHamiltonianMagic.cs @@ -26,7 +26,7 @@ public class FermionHamiltonianLoadMagic : MagicSymbol public FermionHamiltonianLoadMagic() { this.Name = $"%chemistry.fh.load"; - this.Documentation = new Documentation() { Summary = "Loads the fermion Hamiltonian for an electronic structure problem. The problem is loaded from a file or passed as an argument." }; + this.Documentation = new Microsoft.Jupyter.Core.Documentation() { Summary = "Loads the fermion Hamiltonian for an electronic structure problem. The problem is loaded from a file or passed as an argument." }; this.Kind = SymbolKind.Magic; this.Execute = this.Run; } @@ -113,7 +113,10 @@ public class FermionHamiltonianAddTermsMagic : MagicSymbol public FermionHamiltonianAddTermsMagic() { this.Name = $"%chemistry.fh.add_terms"; - this.Documentation = new Documentation() { Summary = "Adds terms to a fermion Hamiltonian." }; + this.Documentation = new Microsoft.Jupyter.Core.Documentation + { + Summary = "Adds terms to a fermion Hamiltonian." + }; this.Kind = SymbolKind.Magic; this.Execute = this.Run; } diff --git a/Chemistry/src/Jupyter/WavefunctionMagic.cs b/Chemistry/src/Jupyter/WavefunctionMagic.cs index bed1d935b78..f32b2bf538e 100644 --- a/Chemistry/src/Jupyter/WavefunctionMagic.cs +++ b/Chemistry/src/Jupyter/WavefunctionMagic.cs @@ -20,7 +20,7 @@ public class WavefunctionMagic : MagicSymbol public WavefunctionMagic() { this.Name = $"%chemistry.inputstate.load"; - this.Documentation = new Documentation() { Summary = "Loads Broombridge electronic structure problem and returns selected input state." }; + this.Documentation = new Microsoft.Jupyter.Core.Documentation() { Summary = "Loads Broombridge electronic structure problem and returns selected input state." }; this.Kind = SymbolKind.Magic; this.Execute = this.Run; } diff --git a/Chemistry/src/Runtime/Runtime.csproj b/Chemistry/src/Runtime/Runtime.csproj index 902c0c66483..cf29d4dedff 100644 --- a/Chemistry/src/Runtime/Runtime.csproj +++ b/Chemistry/src/Runtime/Runtime.csproj @@ -6,6 +6,10 @@ true false True + + Microsoft.Quantum.Chemistry @@ -44,4 +48,3 @@ - diff --git a/MachineLearning/src/MachineLearning.csproj b/MachineLearning/src/MachineLearning.csproj index 73b86c36b20..e26329dac2b 100644 --- a/MachineLearning/src/MachineLearning.csproj +++ b/MachineLearning/src/MachineLearning.csproj @@ -3,6 +3,7 @@ netstandard2.1 Microsoft.Quantum.MachineLearning true + Microsoft.Quantum.MachineLearning 1591 + + + true + + + + Microsoft Microsoft's Quantum standard libraries. @@ -30,7 +37,7 @@ - + diff --git a/Standard/tests/Standard.Tests.csproj b/Standard/tests/Standard.Tests.csproj index 5bf903caf46..c7fdb20e54c 100644 --- a/Standard/tests/Standard.Tests.csproj +++ b/Standard/tests/Standard.Tests.csproj @@ -1,4 +1,4 @@ - + diff --git a/Visualization/src/Visualization.csproj b/Visualization/src/Visualization.csproj index cf3f41e5537..a7ae6e834a2 100644 --- a/Visualization/src/Visualization.csproj +++ b/Visualization/src/Visualization.csproj @@ -32,9 +32,9 @@ - + - +