From 159d249d6807e321ad0b0a0831355445f46c830a Mon Sep 17 00:00:00 2001 From: Bradben Date: Fri, 18 Dec 2020 10:44:47 -0800 Subject: [PATCH 1/3] Update Extensions.cs Problem: Customer reported broken links in the API docs. Cause: Tags were being resolved to xrefs for topics that hadn't been published yet, and have since had their content moved. Fix: Update xrefs with location of correct live content. --- .../DocumentationGenerator/Extensions.cs | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/Documentation/DocumentationGenerator/Extensions.cs b/src/Documentation/DocumentationGenerator/Extensions.cs index 5ee90195ab..76805ebeeb 100644 --- a/src/Documentation/DocumentationGenerator/Extensions.cs +++ b/src/Documentation/DocumentationGenerator/Extensions.cs @@ -296,15 +296,15 @@ internal static Dictionary ToDictionaryOfDeclarations(this $"'{typeParam.Item.TypeName}", _ => type.Resolution.Tag switch { - ResolvedTypeKind.Tags.BigInt => "[BigInt](xref:microsoft.quantum.lang-ref.bigint)", - ResolvedTypeKind.Tags.Bool => "[Bool](xref:microsoft.quantum.lang-ref.bool)", - ResolvedTypeKind.Tags.Double => "[Double](xref:microsoft.quantum.lang-ref.double)", - ResolvedTypeKind.Tags.Int => "[Int](xref:microsoft.quantum.lang-ref.int)", - ResolvedTypeKind.Tags.Pauli => "[Pauli](xref:microsoft.quantum.lang-ref.pauli)", - ResolvedTypeKind.Tags.Qubit => "[Qubit](xref:microsoft.quantum.lang-ref.qubit)", - ResolvedTypeKind.Tags.Range => "[Range](xref:microsoft.quantum.lang-ref.range)", - ResolvedTypeKind.Tags.String => "[String](xref:microsoft.quantum.lang-ref.string)", - ResolvedTypeKind.Tags.UnitType => "[Unit](xref:microsoft.quantum.lang-ref.unit)", + ResolvedTypeKind.Tags.BigInt => "[BigInt](xref:microsoft.quantum.qsharp.valueliterals#bigint-literals)", + ResolvedTypeKind.Tags.Bool => "[Bool](xref:microsoft.quantum.qsharp.valueliterals#bool-literals)", + ResolvedTypeKind.Tags.Double => "[Double](xref:microsoft.quantum.qsharp.valueliterals#double-literals)", + ResolvedTypeKind.Tags.Int => "[Int](xref:microsoft.quantum.qsharp.valueliterals#int-literals)", + ResolvedTypeKind.Tags.Pauli => "[Pauli](xref:microsoft.quantum.qsharp.valueliterals#pauli-literals)", + ResolvedTypeKind.Tags.Qubit => "[Qubit](xref:microsoft.quantum.qsharp.valueliterals#qubit-literals)", + ResolvedTypeKind.Tags.Range => "[Range](xref:microsoft.quantum.qsharp.valueliterals#range-literals)", + ResolvedTypeKind.Tags.String => "[String](xref:microsoft.quantum.qsharp.valueliterals#string-literals)", + ResolvedTypeKind.Tags.UnitType => "[Unit](xref:microsoft.quantum.qsharp.valueliterals#unit-literal)", ResolvedTypeKind.Tags.InvalidType => "__invalid__", _ => $"__invalid<{type.Resolution.ToString()}>__", }, From febe004283e128e4552740eccb77d36b7793a2a7 Mon Sep 17 00:00:00 2001 From: Bradben Date: Fri, 18 Dec 2020 13:24:30 -0800 Subject: [PATCH 2/3] refresh --- src/Documentation/DocumentationGenerator/Extensions.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Documentation/DocumentationGenerator/Extensions.cs b/src/Documentation/DocumentationGenerator/Extensions.cs index 76805ebeeb..c3fc8a5eab 100644 --- a/src/Documentation/DocumentationGenerator/Extensions.cs +++ b/src/Documentation/DocumentationGenerator/Extensions.cs @@ -304,7 +304,7 @@ internal static Dictionary ToDictionaryOfDeclarations(this ResolvedTypeKind.Tags.Qubit => "[Qubit](xref:microsoft.quantum.qsharp.valueliterals#qubit-literals)", ResolvedTypeKind.Tags.Range => "[Range](xref:microsoft.quantum.qsharp.valueliterals#range-literals)", ResolvedTypeKind.Tags.String => "[String](xref:microsoft.quantum.qsharp.valueliterals#string-literals)", - ResolvedTypeKind.Tags.UnitType => "[Unit](xref:microsoft.quantum.qsharp.valueliterals#unit-literal)", + ResolvedTypeKind.Tags.UnitType => "[Unit](xref:microsoft.quantum.qsharp.valueliterals#unit-literals)", ResolvedTypeKind.Tags.InvalidType => "__invalid__", _ => $"__invalid<{type.Resolution.ToString()}>__", }, From 38d37577a48e5ee2c824cf244fd95bf82fc9f193 Mon Sep 17 00:00:00 2001 From: Bradben Date: Fri, 18 Dec 2020 14:27:43 -0800 Subject: [PATCH 3/3] refresh --- src/Documentation/DocumentationGenerator/Extensions.cs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Documentation/DocumentationGenerator/Extensions.cs b/src/Documentation/DocumentationGenerator/Extensions.cs index c3fc8a5eab..76805ebeeb 100644 --- a/src/Documentation/DocumentationGenerator/Extensions.cs +++ b/src/Documentation/DocumentationGenerator/Extensions.cs @@ -304,7 +304,7 @@ internal static Dictionary ToDictionaryOfDeclarations(this ResolvedTypeKind.Tags.Qubit => "[Qubit](xref:microsoft.quantum.qsharp.valueliterals#qubit-literals)", ResolvedTypeKind.Tags.Range => "[Range](xref:microsoft.quantum.qsharp.valueliterals#range-literals)", ResolvedTypeKind.Tags.String => "[String](xref:microsoft.quantum.qsharp.valueliterals#string-literals)", - ResolvedTypeKind.Tags.UnitType => "[Unit](xref:microsoft.quantum.qsharp.valueliterals#unit-literals)", + ResolvedTypeKind.Tags.UnitType => "[Unit](xref:microsoft.quantum.qsharp.valueliterals#unit-literal)", ResolvedTypeKind.Tags.InvalidType => "__invalid__", _ => $"__invalid<{type.Resolution.ToString()}>__", },