From 8e8ee17e90cdc217c1a89be41bd4530741285962 Mon Sep 17 00:00:00 2001
From: Mariia Mykhailova <mamykhai@microsoft.com>
Date: Sat, 5 Feb 2022 11:16:04 -0800
Subject: [PATCH] Add namespace summaries and descriptions. (#519)

---
 Standard/src/Bitwise/Properties/NamespaceInfo.qs      |  4 ++++
 Standard/src/Canon/Properties/NamespaceInfo.qs        | 11 +++++++++++
 .../src/Characterization/Properties/NamespaceInfo.qs  |  4 ++++
 Standard/src/Convert/Properties/NamespaceInfo.qs      |  4 ++++
 .../src/ErrorCorrection/Properties/NamespaceInfo.qs   |  4 ++++
 Standard/src/Logical/Properties/NamespaceInfo.qs      |  5 +++++
 Standard/src/Math/Properties/NamespaceInfo.qs         |  4 ++++
 7 files changed, 36 insertions(+)
 create mode 100644 Standard/src/Canon/Properties/NamespaceInfo.qs

diff --git a/Standard/src/Bitwise/Properties/NamespaceInfo.qs b/Standard/src/Bitwise/Properties/NamespaceInfo.qs
index bf31ede8..6e7f2639 100644
--- a/Standard/src/Bitwise/Properties/NamespaceInfo.qs
+++ b/Standard/src/Bitwise/Properties/NamespaceInfo.qs
@@ -4,4 +4,8 @@
 /// # Summary
 /// This namespace contains functions for acting on the bitwise representation of
 /// classical data types.
+///
+/// # Description
+/// A lot of functions in this namespace offer the same functionality as the 
+/// [bitwise expressions](xref:microsoft.quantum.qsharp.bitwiseexpressions).
 namespace Microsoft.Quantum.Bitwise { }
diff --git a/Standard/src/Canon/Properties/NamespaceInfo.qs b/Standard/src/Canon/Properties/NamespaceInfo.qs
new file mode 100644
index 00000000..8de90de0
--- /dev/null
+++ b/Standard/src/Canon/Properties/NamespaceInfo.qs
@@ -0,0 +1,11 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+/// # Summary
+/// This namespace contains a variety of useful operations and functions.
+///
+/// # Description
+/// To learn more about the operations in this namespace, see 
+/// [Higher-Order Control Flow](xref:microsoft.quantum.libraries.overview-standard.control-flow) and 
+/// [Quantum Fourier Transform](xref:microsoft.quantum.libraries.overview.standard.algorithms#quantum-fourier-transform).
+namespace Microsoft.Quantum.Canon {}
diff --git a/Standard/src/Characterization/Properties/NamespaceInfo.qs b/Standard/src/Characterization/Properties/NamespaceInfo.qs
index a6d9c0db..5c91d529 100644
--- a/Standard/src/Characterization/Properties/NamespaceInfo.qs
+++ b/Standard/src/Characterization/Properties/NamespaceInfo.qs
@@ -4,4 +4,8 @@
 /// # Summary
 /// This namespace contains functions and operations for learning properties of
 /// quantum states and processes, including tomography and phase estimation.
+///
+/// # Description
+/// To learn more about this namespace, see 
+/// [Quantum characterization and statistics](xref:microsoft.quantum.libraries.overview.characterization).
 namespace Microsoft.Quantum.Characterization {}
diff --git a/Standard/src/Convert/Properties/NamespaceInfo.qs b/Standard/src/Convert/Properties/NamespaceInfo.qs
index 1b25e7e6..bf185db0 100644
--- a/Standard/src/Convert/Properties/NamespaceInfo.qs
+++ b/Standard/src/Convert/Properties/NamespaceInfo.qs
@@ -4,4 +4,8 @@
 /// # Summary
 /// This namespace contains functions for converting between various Q# data
 /// types.
+///
+/// # Description
+/// To learn more about this namespace, see 
+/// [Type Conversions](xref:microsoft.quantum.libraries.overview.convert).
 namespace Microsoft.Quantum.Convert {}
diff --git a/Standard/src/ErrorCorrection/Properties/NamespaceInfo.qs b/Standard/src/ErrorCorrection/Properties/NamespaceInfo.qs
index 1aea2cc2..e7e528df 100644
--- a/Standard/src/ErrorCorrection/Properties/NamespaceInfo.qs
+++ b/Standard/src/ErrorCorrection/Properties/NamespaceInfo.qs
@@ -4,4 +4,8 @@
 /// # Summary
 /// This namespace contains functions, operations, and user-defined types for
 /// quantum error correction.
+///
+/// # Description
+/// To learn more about this namespace, see 
+/// [Error Correction](xref:microsoft.quantum.libraries.overview.error-correction).
 namespace Microsoft.Quantum.ErrorCorrection {}
diff --git a/Standard/src/Logical/Properties/NamespaceInfo.qs b/Standard/src/Logical/Properties/NamespaceInfo.qs
index d6bdd2cc..fa912ad0 100644
--- a/Standard/src/Logical/Properties/NamespaceInfo.qs
+++ b/Standard/src/Logical/Properties/NamespaceInfo.qs
@@ -3,4 +3,9 @@
 
 /// # Summary
 /// Contains functions for working with logical expressions and Boolean logic.
+///
+/// # Description
+/// A lot of functions in this namespace offer the same functionality as the 
+/// [logical expressions](xref:microsoft.quantum.qsharp.logicalexpressions) and 
+/// [comparative expressions](xref:microsoft.quantum.qsharp.comparativeexpressions).
 namespace Microsoft.Quantum.Logical { }
diff --git a/Standard/src/Math/Properties/NamespaceInfo.qs b/Standard/src/Math/Properties/NamespaceInfo.qs
index 91ffb343..3ed22e98 100644
--- a/Standard/src/Math/Properties/NamespaceInfo.qs
+++ b/Standard/src/Math/Properties/NamespaceInfo.qs
@@ -3,4 +3,8 @@
 
 /// # Summary
 /// This namespace contains classical mathematical functions and data types.
+///
+/// # Description
+/// A lot of functions in this namespace offer the same functionality as the 
+/// [arithmetic expressions](xref:microsoft.quantum.qsharp.arithmeticexpressions).
 namespace Microsoft.Quantum.Math {}