fix #9102 docgen: sidebar now shows proc signatures instead of encoding (#16857)

1 files changed, 6 insertions, 2 deletions

diff --git a/config/nimdoc.cfg b/config/nimdoc.cfg
index ff4dac781..5e0ea55ac 100644
--- a/config/nimdoc.cfg
+++ b/config/nimdoc.cfg
@@ -34,7 +34,8 @@ doc.section.toc2 = """
 # Available variables are:
 # * $desc: the actual docstring of the item.
 # * $header: the full version of name, including types, pragmas, tags, etc.
-# * $header_plain: like header but without HTML, for attribute embedding.
+# * $header_plain: like header but without HTML (and without pragmas, tags, etc.),
+#   for attribute embedding.
 # * $itemID: numerical unique entry of the item in the HTML.
 # * $itemSym: short symbolic name of the item for easier hyperlinking.
 # * $itemSymEnc: quoted version for URLs or attributes.
@@ -55,6 +56,9 @@ $seeSrc
 
 # Chunk of HTML emitted for each entry in the HTML table of contents.
 # See doc.item for available substitution variables.
+
+# This is used for TOC items which are not overloadable (e.g. types).
+# `$header_plain` would be too verbose here, so we use $name.
 doc.item.toc = """
   <li><a class="reference" href="#$itemSymOrIDEnc"
     title="$header_plain">$name</a></li>
@@ -63,7 +67,7 @@ doc.item.toc = """
 # This is used for TOC items which are grouped by the same name (e.g. procs).
 doc.item.tocTable = """
   <li><a class="reference" href="#$itemSymOrIDEnc"
-    title="$header_plain">$itemSymOrID</a></li>
+    title="$header_plain">$header_plain</a></li>
 """