Rename SpecificationTable to SpecificationSection/Specifications

mdn · Apr 27, 2021 · 9f31dd1 · 9f31dd1
1 parent 4193f3b
commit 9f31dd1
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 13 deletions.
diff --git a/build/document-extractor.js b/build/document-extractor.js
@@ -111,7 +111,7 @@ function extractSections($) {
  *        data: {....}
  *   }]
  *
- * Another example is for specification tables. If the input is this:
+ * Another example is for the specification section. If the input is this:
  *
  *   <h2 id="Specifications">Specifications</h2>
  *   <div class="bc-specs" data-bcd-query="foo.bar.thing">...</div>
@@ -124,7 +124,7 @@ function extractSections($) {
  *        query: "foo.bar.thing",
  *        id: "specifications",
  *        title: "Specifications",
- *        specURLs: {....}
+ *        specifications: {....}
  *   }]
  */
 function addSections($) {

diff --git a/client/src/document/index.tsx b/client/src/document/index.tsx
@@ -9,7 +9,7 @@ import { Doc } from "./types";
 // Ingredients
 import { Prose, ProseWithHeading } from "./ingredients/prose";
 import { LazyBrowserCompatibilityTable } from "./lazy-bcd-table";
-import { SpecificationTable } from "./spec-table";
+import { SpecificationSection } from "./spec-section";
 
 // Misc
 // Sub-components
@@ -235,7 +235,7 @@ function RenderDocumentBody({ doc }) {
       );
     } else if (section.type === "specifications") {
       return (
-        <SpecificationTable key={`specifications${i}`} {...section.value} />
+        <SpecificationSection key={`specifications${i}`} {...section.value} />
       );
     } else {
       console.warn(section);

diff --git a/client/src/document/spec-table.tsx → client/src/document/spec-section.tsx b/client/src/document/spec-table.tsx → client/src/document/spec-section.tsx
@@ -1,6 +1,6 @@
 import { DisplayH2, DisplayH3 } from "./ingredients/utils";
 
-export function SpecificationTable({
+export function SpecificationSection({
   id,
   title,
   isH3,
@@ -38,6 +38,8 @@ export function SpecificationTable({
                 <td>
                   <a href={spec.bcdSpecificationURL}>
                     {spec.title} ({spec.shortTitle})
+                    <br />{" "}
+                    <small>#{spec.bcdSpecificationURL.split("#")[1]}</small>
                   </a>
                 </td>
               </tr>
@@ -46,6 +48,7 @@ export function SpecificationTable({
         </table>
       ) : (
         <div className="notecard warning">
+          <h4>No specification found</h4>
           <p>
             No specification data found for <code>{query}</code>.<br />
             <a href="#on-github">Check for problems with this page</a> or

diff --git a/kumascript/macros/SpecificationTable.ejs → kumascript/macros/Specifications.ejs b/kumascript/macros/SpecificationTable.ejs → kumascript/macros/Specifications.ejs
@@ -8,8 +8,8 @@ $0 – A query string indicating for which feature to retrieve specification URL
 
 Example calls
 
-{{SpecificationTable}}
-{{SpecificationTable("html.element.abbr")}}
+{{Specifications}}
+{{Specifications("html.element.abbr")}}
 
 */
 

diff --git a/...t/tests/macros/SpecificationTable.test.js → ...cript/tests/macros/Specifications.test.js b/...t/tests/macros/SpecificationTable.test.js → ...cript/tests/macros/Specifications.test.js
@@ -3,7 +3,7 @@ const { assert, itMacro, describeMacro, lintHTML } = require("./utils");
 const jsdom = require("jsdom");
 const { JSDOM } = jsdom;
 
-describeMacro("SpecificationTable", function () {
+describeMacro("Specifications", function () {
   itMacro("Outputs a simple div tag", async (macro) => {
     const result = await macro.call("api.feature");
     const dom = JSDOM.fragment(result);

diff --git a/...n-us/web/spec_table_extraction/index.html → ...us/web/spec_section_extraction/index.html b/...n-us/web/spec_table_extraction/index.html → ...us/web/spec_section_extraction/index.html
@@ -1,15 +1,15 @@
 ---
-title: Spec table extraction
+title: Spec section extraction
 browser-compat: javascript.builtins.Array.toLocaleString
-slug: Web/Spec_Table_Extraction
+slug: Web/Spec_Section_Extraction
 ---
 
 <h2>Intro</h2>
 <p>Text in Intro</p>
 
 <h2 id="Specifications">Specifications</h2>
 
-<p>{{SpecificationTable}}</p>
+<p>{{Specifications}}</p>
 
 <h2 id="Browser_compatibility">Browser compatibility</h2>
 

diff --git a/testing/tests/index.test.js b/testing/tests/index.test.js
@@ -1019,13 +1019,13 @@ test("bcd table extraction followed by h3", () => {
   expect(doc.body[4].value.isH3).toBeTruthy();
 });
 
-test("specification table and bcd extraction", () => {
+test("specifications and bcd extraction", () => {
   const builtFolder = path.join(
     buildRoot,
     "en-us",
     "docs",
     "web",
-    "spec_table_extraction"
+    "spec_section_extraction"
   );
   expect(fs.existsSync(builtFolder)).toBeTruthy();
   const jsonFile = path.join(builtFolder, "index.json");