Make auto-links to GH issues less obnoxious (#2143)

speced · Sep 30, 2021 · 8bb5020 · 8bb5020
1 parent 2fe4eaf
commit 8bb5020
Show file tree

Hide file tree

Showing 478 changed files with 5,977 additions and 1,214 deletions.
diff --git a/bikeshed/Spec.py b/bikeshed/Spec.py
@@ -108,6 +108,7 @@ def initializeState(self):
         self.extraStyles["style-autolinks"] = styleAutolinks
         self.extraStyles["style-selflinks"] = styleSelflinks
         self.extraStyles["style-counters"] = styleCounters
+        self.extraStyles["style-issues"] = styleIssues
         self.extraScripts = defaultdict(str)
 
         try:
@@ -867,3 +868,13 @@ def findImplicitInputFile():
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }"""
+
+styleIssues = """
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+"""
diff --git a/bikeshed/boilerplate.py b/bikeshed/boilerplate.py
@@ -1193,7 +1193,9 @@ def addIssuesSection(doc):
         if el.tag not in ("pre", "xmp"):
             el.tag = "div"
         appendChild(container, el)
-        appendChild(el, E.a({"href": "#" + issue.get("id")}, " ↵ "))
+        appendChild(
+            el, " ", E.a({"href": "#" + issue.get("id"), "class": "issue-return", "title": "Jump to section"}, "↵")
+        )
     for idel in findAll("[id]", container):
         del idel.attrib["id"]
     for dfnel in findAll(config.dfnElementsSelector, container):

diff --git a/bikeshed/unsortedJunk.py b/bikeshed/unsortedJunk.py
@@ -1102,7 +1102,7 @@ def processIssuesAndExamples(doc):
             elif doc.md.issueTrackerTemplate:
                 remoteIssueURL = doc.md.issueTrackerTemplate.format(remoteIssueID)
             if remoteIssueURL:
-                appendChild(el, " ", E.a({"href": remoteIssueURL}, "<" + remoteIssueURL + ">"))
+                appendChild(el, " ", E.a({"href": remoteIssueURL}, "[Issue #" + remoteIssueID + "]"))
     for el in findAll(".example:not([id])", doc):
         el.set("id", safeID(doc, "example-" + hashContents(el)))
     fixupIDs(doc, findAll(".issue, .example", doc))

diff --git a/tests/abstract001.html b/tests/abstract001.html
@@ -204,6 +204,16 @@
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }</style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/adjacent-boilerplate/adjacent-boilerplate.html b/tests/adjacent-boilerplate/adjacent-boilerplate.html
@@ -245,6 +245,16 @@
 
 .dfn-paneled { cursor: pointer; }
 </style>
+<style>/* style-issues */
+
+a.issue-return {
+    float: right;
+    float: end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/advisement001.html b/tests/advisement001.html
@@ -204,6 +204,16 @@
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }</style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec
@@ -428,5 +438,5 @@ <h2 class="no-num no-toc no-ref" id="contents">Table of Contents</h2>
   </main>
   <h2 class="no-num no-ref heading settled" id="issues-index"><span class="content">Issues Index</span></h2>
   <div style="counter-reset:issue">
-   <div class="issue"> This is an issue.<a href="#issue-05237a4c"> ↵ </a></div>
+   <div class="issue"> This is an issue. <a class="issue-return" href="#issue-05237a4c" title="Jump to section">↵</a></div>
   </div>
diff --git a/tests/algorithm001.html b/tests/algorithm001.html
@@ -204,6 +204,16 @@
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }</style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/basic001.html b/tests/basic001.html
@@ -204,6 +204,16 @@
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }</style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/biblio001.html b/tests/biblio001.html
@@ -204,6 +204,16 @@
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }</style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/biblio002.html b/tests/biblio002.html
@@ -204,6 +204,16 @@
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }</style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/biblio003.html b/tests/biblio003.html
@@ -204,6 +204,16 @@
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }</style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/biblio004.html b/tests/biblio004.html
@@ -204,6 +204,16 @@
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }</style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/biblio005.html b/tests/biblio005.html
@@ -204,6 +204,16 @@
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }</style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/biblio006.html b/tests/biblio006.html
@@ -204,6 +204,16 @@
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }</style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/boilerplate-substitution001.html b/tests/boilerplate-substitution001.html
@@ -204,6 +204,16 @@
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }</style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/caniuse001.html b/tests/caniuse001.html
@@ -250,6 +250,16 @@
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }</style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/comments001.html b/tests/comments001.html
@@ -204,6 +204,16 @@
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }</style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/conditional001.html b/tests/conditional001.html
@@ -204,6 +204,16 @@
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }</style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/conditional002.html b/tests/conditional002.html
@@ -204,6 +204,16 @@
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }</style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/conditional003.html b/tests/conditional003.html
@@ -204,6 +204,16 @@
 figcaption:not(.no-marker)::before {
     content: "Figure " counter(figure) " ";
 }</style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/css-production-range001.html b/tests/css-production-range001.html
@@ -245,6 +245,16 @@
 
 .dfn-paneled { cursor: pointer; }
 </style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/dict-type.html b/tests/dict-type.html
@@ -245,6 +245,16 @@
 
 .dfn-paneled { cursor: pointer; }
 </style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec

diff --git a/tests/elementdef001.html b/tests/elementdef001.html
@@ -245,6 +245,16 @@
 
 .dfn-paneled { cursor: pointer; }
 </style>
+<style>/* style-issues */
+
+a[href].issue-return {
+    float: right;
+    float: inline-end;
+    color: var(--issueheading-text);
+    font-weight: bold;
+    text-decoration: none;
+}
+</style>
 <style>/* style-md-lists */
 
 /* This is a weird hack for me not yet following the commonmark spec