fix: update client header to use <h3> instead of <h2> (#179)

alicejli · web-flow · commit b67fff39c813 · 2023-05-04T10:53:32.000-04:00
diff --git a/third_party/docfx-doclet-143274/src/main/java/com/microsoft/util/YamlUtil.java b/third_party/docfx-doclet-143274/src/main/java/com/microsoft/util/YamlUtil.java
@@ -35,6 +35,6 @@ public static String cleanupHtml(String text) {
                 .replaceAll("\\{@link *\"([^\\{]+)\" *\\}", "<a href=\"$1\">$1</a>")
                 .replaceAll("\\[([^]]+)]\\[([^]]+)\\]", "<xref uid=\"$2\" data-throw-if-not-resolved=\"false\">$1</xref>")
                 .replaceAll("\\{@link *([^\\{\"]+) *\\}", "<xref uid=\"$1\" data-throw-if-not-resolved=\"false\">$1</xref>")
-                .replaceAll("=======================([^=]+)=======================", "<h2>$1</h2>");
+                .replaceAll("=======================([^=]+)=======================", "<h3>$1</h3>");
     }
 }
diff --git a/third_party/docfx-doclet-143274/src/test/java/com/microsoft/util/YamlUtilTest.java b/third_party/docfx-doclet-143274/src/test/java/com/microsoft/util/YamlUtilTest.java
@@ -121,7 +121,7 @@ public void cleanupHtmlAddHrefTagsTest() {
     @Test
     public void cleanupHtmlEqualTitlesTest() {
         String expectedActual = "======================= SpeechClient =======================";
-        String expectedResult = "<h2> SpeechClient </h2>";
+        String expectedResult = "<h3> SpeechClient </h3>";
         String random = UUID.randomUUID().toString();
 
         assertEquals(expectedResult, YamlUtil.cleanupHtml(expectedActual));
diff --git a/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.yml b/third_party/docfx-doclet-143274/src/test/resources/expected-generated-files/com.microsoft.samples.yml
@@ -20,7 +20,7 @@ items:
   nameWithType: "com.microsoft.samples"
   fullName: "com.microsoft.samples"
   type: "Namespace"
-  summary: "The interfaces provided are listed below, along with usage samples.\n\n <p><h2> SpeechClient </h2>\n\n <p>Service Description: Service that implements Google Cloud Speech API.\n\n <p>Sample for SpeechClient:\n\n <pre class=\"prettyprint lang-java\"><code>\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognitionConfig config = RecognitionConfig.newBuilder().build();\n   RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n   RecognizeResponse response = speechClient.recognize(config, audio);\n }\n </code></pre>\n\n <p><h2> AdaptationClient </h2>\n\n <p>Service Description: Service that implements Google Cloud Speech Adaptation API.\n\n <p>Sample for AdaptationClient:\n\n <pre class=\"prettyprint lang-java\"><code>\n try (AdaptationClient adaptationClient = AdaptationClient.create()) {\n   LocationName parent = LocationName.of(\"[PROJECT]\", \"[LOCATION]\");\n   PhraseSet phraseSet = PhraseSet.newBuilder().build();\n   String phraseSetId = \"phraseSetId959902180\";\n   PhraseSet response = adaptationClient.createPhraseSet(parent, phraseSet, phraseSetId);\n }\n </code></pre>"
+  summary: "The interfaces provided are listed below, along with usage samples.\n\n <p><h3> SpeechClient </h3>\n\n <p>Service Description: Service that implements Google Cloud Speech API.\n\n <p>Sample for SpeechClient:\n\n <pre class=\"prettyprint lang-java\"><code>\n try (SpeechClient speechClient = SpeechClient.create()) {\n   RecognitionConfig config = RecognitionConfig.newBuilder().build();\n   RecognitionAudio audio = RecognitionAudio.newBuilder().build();\n   RecognizeResponse response = speechClient.recognize(config, audio);\n }\n </code></pre>\n\n <p><h3> AdaptationClient </h3>\n\n <p>Service Description: Service that implements Google Cloud Speech Adaptation API.\n\n <p>Sample for AdaptationClient:\n\n <pre class=\"prettyprint lang-java\"><code>\n try (AdaptationClient adaptationClient = AdaptationClient.create()) {\n   LocationName parent = LocationName.of(\"[PROJECT]\", \"[LOCATION]\");\n   PhraseSet phraseSet = PhraseSet.newBuilder().build();\n   String phraseSetId = \"phraseSetId959902180\";\n   PhraseSet response = adaptationClient.createPhraseSet(parent, phraseSet, phraseSetId);\n }\n </code></pre>"
   syntax:
     content: "package com.microsoft.samples"
   javaType: "package"

Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,6 @@ public static String cleanupHtml(String text) {`
`35`	`35`	`.replaceAll("\\{@link \"([^\\{]+)\" \\}", "<a href=\"$1\">$1</a>")`
`36`	`36`	`.replaceAll("\\[([^]]+)]\\[([^]]+)\\]", "<xref uid=\"$2\" data-throw-if-not-resolved=\"false\">$1</xref>")`
`37`	`37`	`.replaceAll("\\{@link ([^\\{\"]+) \\}", "<xref uid=\"$1\" data-throw-if-not-resolved=\"false\">$1</xref>")`
`38`		`- .replaceAll("=======================([^=]+)=======================", "<h2>$1</h2>");`
	`38`	`+ .replaceAll("=======================([^=]+)=======================", "<h3>$1</h3>");`
`39`	`39`	`}`
`40`	`40`	`}`