Add namespace summaries and descriptions. (#519)

This commit is contained in:
Mariia Mykhailova 2022-02-05 11:16:04 -08:00 коммит произвёл GitHub
Родитель 6f41efc6fc
Коммит 8e8ee17e90
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
7 изменённых файлов: 36 добавлений и 0 удалений

Просмотреть файл

@ -4,4 +4,8 @@
/// # Summary /// # Summary
/// This namespace contains functions for acting on the bitwise representation of /// This namespace contains functions for acting on the bitwise representation of
/// classical data types. /// 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 { } namespace Microsoft.Quantum.Bitwise { }

Просмотреть файл

@ -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 {}

Просмотреть файл

@ -4,4 +4,8 @@
/// # Summary /// # Summary
/// This namespace contains functions and operations for learning properties of /// This namespace contains functions and operations for learning properties of
/// quantum states and processes, including tomography and phase estimation. /// 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 {} namespace Microsoft.Quantum.Characterization {}

Просмотреть файл

@ -4,4 +4,8 @@
/// # Summary /// # Summary
/// This namespace contains functions for converting between various Q# data /// This namespace contains functions for converting between various Q# data
/// types. /// types.
///
/// # Description
/// To learn more about this namespace, see
/// [Type Conversions](xref:microsoft.quantum.libraries.overview.convert).
namespace Microsoft.Quantum.Convert {} namespace Microsoft.Quantum.Convert {}

Просмотреть файл

@ -4,4 +4,8 @@
/// # Summary /// # Summary
/// This namespace contains functions, operations, and user-defined types for /// This namespace contains functions, operations, and user-defined types for
/// quantum error correction. /// quantum error correction.
///
/// # Description
/// To learn more about this namespace, see
/// [Error Correction](xref:microsoft.quantum.libraries.overview.error-correction).
namespace Microsoft.Quantum.ErrorCorrection {} namespace Microsoft.Quantum.ErrorCorrection {}

Просмотреть файл

@ -3,4 +3,9 @@
/// # Summary /// # Summary
/// Contains functions for working with logical expressions and Boolean logic. /// 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 { } namespace Microsoft.Quantum.Logical { }

Просмотреть файл

@ -3,4 +3,8 @@
/// # Summary /// # Summary
/// This namespace contains classical mathematical functions and data types. /// 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 {} namespace Microsoft.Quantum.Math {}