Show aliases in specification documentation

rubygems · Jun 23, 2024 · 3df3cd4 · 3df3cd4
1 parent caf6821
commit 3df3cd4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/rdoc/generator/template/jekdoc/classpage.rhtml b/rdoc/generator/template/jekdoc/classpage.rhtml
@@ -67,6 +67,9 @@ next: /command-reference
    description.gsub! %r%<a\shref=(["'])Specification\.html\1>Specification</a>%,
                      'Specification' %>
 <%= description %>
+<% if method.aliases.any? -%>
+Also known as: **<%= method.aliases.map(&:name).join(", ") %>**
+<% end -%>
 <% end -%>
 <% end -%>
 

diff --git a/specification-reference.md b/specification-reference.md
@@ -347,6 +347,7 @@ next: /command-reference
 
 <pre class="ruby"><span class="ruby-identifier">spec</span>.<span class="ruby-identifier">add_runtime_dependency</span> <span class="ruby-string">&#39;example&#39;</span>, <span class="ruby-string">&#39;~&gt; 1.1&#39;</span>, <span class="ruby-string">&#39;&gt;= 1.1.4&#39;</span>
 </pre>
+Also known as: **add_dependency**
 
 <a id="author="> </a>
-Original file line number
+Diff line change
@@ Expand Up / @@ -347,6 +347,7 @@ next: /command-reference @@
     <pre class="ruby"><span class="ruby-identifier">spec</span>.<span class="ruby-identifier">add_runtime_dependency</span> <span class="ruby-string">&#39;example&#39;</span>, <span class="ruby-string">&#39;~&gt; 1.1&#39;</span>, <span class="ruby-string">&#39;&gt;= 1.1.4&#39;</span>
     </pre>
+    Also known as: **add_dependency**
     <a id="author="> </a>
@@ Expand Down @@