rdoc 6.4.0 → 6.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6c9787594ed9d69a7a9177e449d925063acbc6ace0273f7d0b1fc9ca6a31139
-  data.tar.gz: 5f5afd10a18a1aeabc8319350c191eeaa137e5f715a2e95cbf2443f5dca7f96c
+  metadata.gz: 947667e0cc733b38e36c829627ea1cca454420e44124b9536bf7f6ab7c687688
+  data.tar.gz: ce0d8a98c383e7c6b03138fbb62a31626bb24a20be3967aefa3c29a302b0d9f6
 SHA512:
-  metadata.gz: 94fbc007d81c0cc1774b44d5f174b5e011ef5ae3d998344b981a8b6170f1c630c3c80e45f87bcc4c05f97f51e34e9f3ede791846e0c01e4015c45cc8aab1b05e
-  data.tar.gz: '068da922a56b61ca85fa7b61d5554cdbe1533c30caae11e7d81894e41fca58157971c18a76c55391538324c168a720c2cbbc8150a12dc276eab033e70fae0217'
+  metadata.gz: dd6e321fe810da6ed4b5257df5347474adb514b061c9c5ad981c57feef340544e6e51fe9bfe48ef31bc7eaa87fc179883635d5448f6f2ab669443adcd6e98d46
+  data.tar.gz: 1c7d9158ca93ab8a913f282d6a641bc6d2f69eecf779b452d93fb935f6fde8e0e536d186ca8c2eba90a58a31ffd34cffd9af7a220fd5ff0ed63da6cf68ad8ed2

data/CONTRIBUTING.rdoc

@@ -34,8 +34,7 @@ RDoc uses bundler for development.  To get ready to work on RDoc run:
 This will install all the necessary dependencies for development with rake,
 generate documentation and run the tests for the first time.
 
-If the tests don't pass on the first run check the {Travis CI page for
-RDoc}[https://travis-ci.org/ruby/rdoc] to see if there are any known failures
+If the tests don't pass on the first run check the {GitHub Actions page}[https://github.com/ruby/rdoc/actions] to see if there are any known failures
 (there shouldn't be).
 
 You can now use `rake` and `autotest` to run the tests.

data/LEGAL.rdoc

@@ -5,7 +5,7 @@
 The files in this distribution are covered by the Ruby license (see LICENSE) except the features mentioned below:
 
 Darkfish::
-  Darkfish was written by Michael Granger and is included under the MIT
+  Darkfish was written by Michael Granger and is included under the BSD 3-Clause
   license.  Darkfish contains images from the Silk Icons set by Mark James.
 
   See lib/rdoc/generator/darkfish.rb for license information.

data/README.rdoc

@@ -3,7 +3,7 @@
 home :: https://github.com/ruby/rdoc
 rdoc :: https://ruby.github.io/rdoc
 bugs :: https://github.com/ruby/rdoc/issues
-code quality :: {<img src="https://codeclimate.com/github/ruby/rdoc/badges/gpa.svg" alt="Code Climate">}[https://codeclimate.com/github/ruby/rdoc]
+code quality :: https://codeclimate.com/github/ruby/rdoc
 
 == Description
 
@@ -46,7 +46,7 @@ contain just Markup-style markup (with or without leading '#' comment
 markers).  If directory names are passed to RDoc, they are scanned
 recursively for C and Ruby source files only.
 
-To generate documentation using +rake+ see RDoc::Task[https://ruby.github.io/rdoc/RDocTask.html].
+To generate documentation using +rake+ see RDoc::Task[https://ruby.github.io/rdoc/RDoc/Task.html].
 
 To generate documentation programmatically:
 

data/TODO.rdoc

@@ -26,7 +26,7 @@ Nice to have:
 * Global variable support
 * Provide the code_object to directive handlers
 
-=== 4
+=== More Future
 
 API changes to RDoc
 

data/exe/rdoc

@@ -41,4 +41,3 @@ rescue Exception => e
 
   exit 1
 end
-

data/lib/rdoc/alias.rb

@@ -109,4 +109,3 @@ class RDoc::Alias < RDoc::CodeObject
   end
 
 end
-

data/lib/rdoc/anon_class.rb

@@ -8,4 +8,3 @@
 
 class RDoc::AnonClass < RDoc::ClassModule
 end
-

data/lib/rdoc/any_method.rb

@@ -115,6 +115,13 @@ class RDoc::AnyMethod < RDoc::MethodAttr
     @call_seq = call_seq
   end
 
+  ##
+  # Whether the method has a call-seq.
+
+  def has_call_seq?
+    !!(@call_seq || is_alias_for&._call_seq)
+  end
+
   ##
   # Loads is_alias_for from the internal name.  Returns nil if the alias
   # cannot be found.
@@ -296,6 +303,14 @@ class RDoc::AnyMethod < RDoc::MethodAttr
     params
   end
 
+  ##
+  # Whether to skip the method description, true for methods that have
+  # aliases with a call-seq that doesn't include the method name.
+
+  def skip_description?
+    has_call_seq? && call_seq.nil? && !!(is_alias_for || !aliases.empty?)
+  end
+
   ##
   # Sets the store for this method and its referenced code objects.
 
@@ -350,12 +365,12 @@ class RDoc::AnyMethod < RDoc::MethodAttr
       ignore << is_alias_for.name
       ignore.concat is_alias_for.aliases.map(&:name)
     end
-    ignore.map! { |n| n =~ /\A\[/ ? n[0, 1] : n}
+    ignore.map! { |n| n =~ /\A\[/ ? /\[.*\]/ : n}
     ignore.delete(method_name)
     ignore = Regexp.union(ignore)
 
     matching = entries.reject do |entry|
-      entry =~ /^\w*\.?#{ignore}/ or
+      entry =~ /^\w*\.?#{ignore}[$\(\s]/ or
         entry =~ /\s#{ignore}\s/
     end
 

data/lib/rdoc/attr.rb

@@ -173,4 +173,3 @@ class RDoc::Attr < RDoc::MethodAttr
   end
 
 end
-

data/lib/rdoc/class_module.rb

@@ -799,4 +799,3 @@ class RDoc::ClassModule < RDoc::Context
   end
 
 end
-

data/lib/rdoc/code_objects.rb

@@ -2,5 +2,4 @@
 # This file was used to load all the RDoc::CodeObject subclasses at once.  Now
 # autoload handles this.
 
-require 'rdoc'
-
+require_relative '../rdoc'

data/lib/rdoc/comment.rb

@@ -6,8 +6,8 @@
 # Each comment may have a different markup format set by #format=.  By default
 # 'rdoc' is used.  The :markup: directive tells RDoc which format to use.
 #
-# See RDoc::Markup@Other+directives for instructions on adding an alternate
-# format.
+# See RDoc::MarkupReference@Directive+for+Specifying+RDoc+Source+Format.
+
 
 class RDoc::Comment
 
@@ -97,42 +97,26 @@ class RDoc::Comment
     # comment.  The difficulty is to make sure not to match lines starting
     # with ARGF at the same indent, but that are after the first description
     # paragraph.
-    if @text =~ /^\s*:?call-seq:(.*?(?:\S).*?)^\s*$/m then
+    if /^(?<S> ((?!\n)\s)*+        (?# whitespaces except newline))
+         :?call-seq:
+           (?<B> \g<S>(?<N>\n|\z)  (?# trailing spaces))?
+         (?<seq>
+           (\g<S>(?!\w)\S.*\g<N>)*
+           (?>
+             (?<H> \g<S>\w+        (?# ' #   ARGF' in the example above))
+             .*\g<N>)?
+           (\g<S>\S.*\g<N>         (?# other non-blank line))*+
+           (\g<B>+(\k<H>.*\g<N>    (?# ARGF.to_a lines))++)*+
+         )
+         (?m:^\s*$|\z)
+        /x =~ @text
+      seq = $~[:seq]
+
       all_start, all_stop = $~.offset(0)
-      seq_start, seq_stop = $~.offset(1)
-
-      # we get the following lines that start with the leading word at the
-      # same indent, even if they have blank lines before
-      if $1 =~ /(^\s*\n)+^(\s*\w+)/m then
-        leading = $2 # ' *    ARGF' in the example above
-        re = %r%
-          \A(
-             (^\s*\n)+
-             (^#{Regexp.escape leading}.*?\n)+
-            )+
-          ^\s*$
-        %xm
-
-        if @text[seq_stop..-1] =~ re then
-          all_stop = seq_stop + $~.offset(0).last
-          seq_stop = seq_stop + $~.offset(1).last
-        end
-      end
-
-      seq = @text[seq_start..seq_stop]
-      seq.gsub!(/^\s*(\S|\n)/m, '\1')
       @text.slice! all_start...all_stop
 
-      method.call_seq = seq.chomp
-
-    else
-      regexp = /^\s*:?call-seq:(.*?)(^\s*$|\z)/m
-      if regexp =~ @text then
-        @text = @text.sub(regexp, '')
-        seq = $1
-        seq.gsub!(/^\s*/, '')
-        method.call_seq = seq
-      end
+      seq.gsub!(/^\s*/, '')
+      method.call_seq = seq
     end
 
     method
@@ -149,12 +133,7 @@ class RDoc::Comment
   # HACK dubious
 
   def encode! encoding
-    # TODO: Remove this condition after Ruby 2.2 EOL
-    if RUBY_VERSION < '2.3.0'
-      @text = @text.force_encoding encoding
-    else
-      @text = String.new @text, encoding: encoding
-    end
+    @text = String.new @text, encoding: encoding
     self
   end
 

data/lib/rdoc/constant.rb

@@ -184,4 +184,3 @@ class RDoc::Constant < RDoc::CodeObject
   end
 
 end
-

data/lib/rdoc/context/section.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
+require 'cgi/util'
+
 ##
 # A section of documentation like:
 #
@@ -229,4 +231,3 @@ class RDoc::Context::Section
   end
 
 end
-

data/lib/rdoc/context.rb

@@ -1,6 +1,4 @@
 # frozen_string_literal: true
-require 'cgi'
-
 ##
 # A Context is something that can hold modules, classes, methods, attributes,
 # aliases, requires, and includes. Classes, modules, and files are all
@@ -1261,6 +1259,6 @@ class RDoc::Context < RDoc::CodeObject
     klass
   end
 
-  autoload :Section, 'rdoc/context/section'
+  autoload :Section, "#{__dir__}/context/section"
 
 end

data/lib/rdoc/cross_reference.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: true
+
+require_relative 'markup/attribute_manager' # for PROTECT_ATTR
+
 ##
 # RDoc::CrossReference is a reusable way to create cross references for names.
 
@@ -14,12 +17,25 @@ class RDoc::CrossReference
 
   CLASS_REGEXP_STR = '\\\\?((?:\:{2})?[A-Z]\w*(?:\:\:\w+)*)'
 
+  ##
+  # Regular expression to match a single method argument.
+
+  METHOD_ARG_REGEXP_STR = '[\w.+*/=<>-]+'
+
+  ##
+  # Regular expression to match method arguments.
+
+  METHOD_ARGS_REGEXP_STR = /(?:\((?:#{METHOD_ARG_REGEXP_STR}(?:,\s*#{METHOD_ARG_REGEXP_STR})*)?\))?/.source
+
   ##
   # Regular expression to match method references.
   #
   # See CLASS_REGEXP_STR
 
-  METHOD_REGEXP_STR = '([A-Za-z]\w*[!?=]?|%|===?|\[\]=?|<<|>>|\+@|-@|-|\+|\*)(?:\([\w.+*/=<>-]*\))?'
+  METHOD_REGEXP_STR = /(
+    (?!\d)[\w#{RDoc::Markup::AttributeManager::PROTECT_ATTR}]+[!?=]?|
+    %|=(?:==?|~)|![=~]|\[\]=?|<(?:<|=>?)?|>[>=]?|[-+!]@?|\*\*?|[\/%\`|&^~]
+  )#{METHOD_ARGS_REGEXP_STR}/.source.delete("\n ").freeze
 
   ##
   # Regular expressions matching text that should potentially have
@@ -207,4 +223,3 @@ class RDoc::CrossReference
   end
 
 end
-

data/lib/rdoc/encoding.rb

@@ -124,12 +124,7 @@ module RDoc::Encoding
     if text.kind_of? RDoc::Comment
       text.encode! encoding
     else
-      # TODO: Remove this condition after Ruby 2.2 EOL
-      if RUBY_VERSION < '2.3.0'
-        text.force_encoding encoding
-      else
-        String.new text, encoding: encoding
-      end
+      String.new text, encoding: encoding
     end
   end
 

data/lib/rdoc/erb_partial.rb

@@ -16,4 +16,3 @@ class RDoc::ERBPartial < ERB
   end
 
 end
-

data/lib/rdoc/erbio.rb

@@ -20,12 +20,8 @@ class RDoc::ERBIO < ERB
   ##
   # Defaults +eoutvar+ to 'io', otherwise is identical to ERB's initialize
 
-  def initialize str, safe_level = nil, legacy_trim_mode = nil, legacy_eoutvar = 'io', trim_mode: nil, eoutvar: 'io'
-    if RUBY_VERSION >= '2.6'
-      super(str, trim_mode: trim_mode, eoutvar: eoutvar)
-    else
-      super(str, safe_level, legacy_trim_mode, legacy_eoutvar)
-    end
+  def initialize str, trim_mode: nil, eoutvar: 'io'
+    super(str, trim_mode: trim_mode, eoutvar: eoutvar)
   end
 
   ##
@@ -39,4 +35,3 @@ class RDoc::ERBIO < ERB
   end
 
 end
-

data/lib/rdoc/extend.rb

@@ -7,4 +7,3 @@
 class RDoc::Extend < RDoc::Mixin
 
 end
-

data/lib/rdoc/generator/darkfish.rb

@@ -610,7 +610,7 @@ class RDoc::Generator::Darkfish
 
     @classes = @store.all_classes_and_modules.sort
     @files   = @store.all_files.sort
-    @methods = @classes.map { |m| m.method_list }.flatten.sort
+    @methods = @classes.flat_map { |m| m.method_list }.sort
     @modsort = get_sorted_module_list @classes
   end
 
@@ -778,11 +778,7 @@ class RDoc::Generator::Darkfish
       erbout = "_erbout_#{file_var}"
     end
 
-    if RUBY_VERSION >= '2.6'
-      template = klass.new template, trim_mode: '-', eoutvar: erbout
-    else
-      template = klass.new template, nil, '-', erbout
-    end
+    template = klass.new template, trim_mode: '-', eoutvar: erbout
     @template_cache[file] = template
     template
   end

data/lib/rdoc/generator/json_index.rb

@@ -230,9 +230,9 @@ class RDoc::Generator::JsonIndex
   def index_methods
     debug_msg "  generating method search index"
 
-    list = @classes.uniq.map do |klass|
+    list = @classes.uniq.flat_map do |klass|
       klass.method_list
-    end.flatten.sort_by do |method|
+    end.sort_by do |method|
       [method.name, method.parent.full_name]
     end
 

data/lib/rdoc/generator/markup.rb

@@ -109,7 +109,7 @@ class RDoc::MethodAttr
     lines.shift if src =~ /\A.*#\ *File/i # remove '# File' comment
     lines.each do |line|
       if line =~ /^ *(?=\S)/
-        n = $&.length
+        n = $~.end(0)
         indent = n if n < indent
         break if n == 0
       end
@@ -157,4 +157,3 @@ class RDoc::TopLevel
   end
 
 end
-

data/lib/rdoc/generator/ri.rb

@@ -28,4 +28,3 @@ class RDoc::Generator::RI
   end
 
 end
-

data/lib/rdoc/generator/template/darkfish/_head.rhtml

@@ -3,18 +3,18 @@
 <title><%= h @title %></title>
 
 <script type="text/javascript">
-  var rdoc_rel_prefix = "<%= asset_rel_prefix %>/";
-  var index_rel_prefix = "<%= rel_prefix %>/";
+  var rdoc_rel_prefix = "<%= h asset_rel_prefix %>/";
+  var index_rel_prefix = "<%= h rel_prefix %>/";
 </script>
 
-<script src="<%= asset_rel_prefix %>/js/navigation.js" defer></script>
-<script src="<%= asset_rel_prefix %>/js/search.js" defer></script>
-<script src="<%= asset_rel_prefix %>/js/search_index.js" defer></script>
-<script src="<%= asset_rel_prefix %>/js/searcher.js" defer></script>
-<script src="<%= asset_rel_prefix %>/js/darkfish.js" defer></script>
+<script src="<%= h asset_rel_prefix %>/js/navigation.js" defer></script>
+<script src="<%= h asset_rel_prefix %>/js/search.js" defer></script>
+<script src="<%= h asset_rel_prefix %>/js/search_index.js" defer></script>
+<script src="<%= h asset_rel_prefix %>/js/searcher.js" defer></script>
+<script src="<%= h asset_rel_prefix %>/js/darkfish.js" defer></script>
 
-<link href="<%= asset_rel_prefix %>/css/fonts.css" rel="stylesheet">
-<link href="<%= asset_rel_prefix %>/css/rdoc.css" rel="stylesheet">
+<link href="<%= h asset_rel_prefix %>/css/fonts.css" rel="stylesheet">
+<link href="<%= h asset_rel_prefix %>/css/rdoc.css" rel="stylesheet">
 <%- @options.template_stylesheets.each do |stylesheet| -%>
-<link href="<%= asset_rel_prefix %>/<%= File.basename stylesheet %>" rel="stylesheet">
+<link href="<%= h asset_rel_prefix %>/<%= File.basename stylesheet %>" rel="stylesheet">
 <%- end -%>

data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml

@@ -1,9 +1,33 @@
 <div id="classindex-section" class="nav-section">
   <h3>Class and Module Index</h3>
 
+  <%-
+  all_classes = @classes.group_by do |klass|
+    klass.full_name[/\A[^:]++(?:::[^:]++(?=::))*+(?=::[^:]*+\z)/]
+  end.delete_if do |_, klasses|
+    !klasses.any?(&:display?)
+  end
+  link = proc do |index_klass, display = index_klass.display?|
+    if display
+      -%><code><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.name %></a></code><%-
+    else
+      -%><code><%= index_klass.name %></code><%-
+    end
+  end
+  if top = all_classes[nil]
+    solo = top.one? {|klass| klass.display?}
+    traverse = proc do |klasses| -%>
   <ul class="link-list">
-  <%- @modsort.each do |index_klass| -%>
-    <li><a href="<%= rel_prefix %>/<%= index_klass.path %>"><%= index_klass.full_name %></a>
+      <%- klasses.each do |index_klass| -%>
+        <%- if children = all_classes[index_klass.full_name] -%>
+  <li><details<% if solo; solo = false %> open<% end %>><summary><% link.call(index_klass) %></summary>
+          <%- traverse.call(children) -%>
+  </ul></details>
+        <%- elsif index_klass.display? -%>
+  <li><% link.call(index_klass, true) %>
+        <%- end -%>
+      <%- end -%>
+    <%- end -%>
+    <%- traverse.call(top) -%>
   <%- end -%>
-  </ul>
 </div>

data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml

@@ -1,11 +1,31 @@
 <%- simple_files = @files.select { |f| f.text? } %>
+<%- if defined?(current) -%>
+  <%- dir = current.full_name[%r{\A[^/]+(?=/)}] || current.page_name -%>
+<%- end -%>
 <%- unless simple_files.empty? then -%>
 <div id="fileindex-section" class="nav-section">
   <h3>Pages</h3>
 
   <ul class="link-list">
-  <%- simple_files.each do |f| -%>
-    <li><a href="<%= rel_prefix %>/<%= f.path %>"><%= h f.page_name %></a>
+  <%- simple_files.group_by do |f| -%>
+    <%- f.full_name[%r{\A[^/]+(?=/)}] || f.page_name -%>
+  <%- end.each do |n, files| -%>
+    <%- f = files.shift -%>
+    <%- if files.empty? -%>
+    <li><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h f.page_name %></a>
+      <%- next -%>
+    <%- end -%>
+    <li><details<% if dir == n %> open<% end %>><summary><%
+    if n == f.page_name
+      %><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h n %></a><%
+    else
+      %><%= h n %><% files.unshift(f)
+    end %></summary>
+    <ul class="link-list">
+    <%- files.each do |f| -%>
+      <li><a href="<%= rel_prefix %>/<%= h f.path %>"><%= h f.page_name %></a>
+    <%- end -%>
+    </ul></details>
   <%- end -%>
   </ul>
 </div>

data/lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml

@@ -3,7 +3,7 @@
     <div id="search-field-wrapper">
       <input id="search-field" role="combobox" aria-label="Search"
              aria-autocomplete="list" aria-controls="search-results"
-             type="text" name="search" placeholder="Search" spellcheck="false"
+             type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
              title="Type to search, Up and Down to navigate, Enter to load">
     </div>
 

data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml

@@ -3,16 +3,37 @@
              else
                current.comment
              end
-   table = current.parse(comment).table_of_contents
+   table = current.parse(comment).table_of_contents.dup
 
    if table.length > 1 then %>
 <div class="nav-section">
   <h3>Table of Contents</h3>
 
+    <%- display_link = proc do |heading| -%>
+      <a href="#<%= heading.label current %>"><%= heading.plain_html %></a>
+    <%- end -%>
+
+    <%- list_siblings = proc do -%>
+      <%- level = table.first&.level -%>
+      <%- while table.first && table.first.level >= level -%>
+        <%- heading = table.shift -%>
+        <%- if table.first.nil? || table.first.level <= heading.level -%>
+          <li><% display_link.call heading -%>
+        <%- else -%>
+          <li>
+            <details open>
+              <summary><%- display_link.call heading -%></summary>
+              <ul class="link-list" role="directory">
+                <% list_siblings.call %>
+              </ul>
+            </details>
+          </li>
+        <%- end -%>
+      <%- end -%>
+    <%- end -%>
+
   <ul class="link-list" role="directory">
-<%-   table.each do |heading| -%>
-    <li><a href="#<%= heading.label current %>"><%= heading.plain_html %></a>
-<%-   end -%>
+    <% list_siblings.call %>
   </ul>
 </div>
 <%- end -%>

data/lib/rdoc/generator/template/darkfish/class.rhtml

@@ -98,29 +98,36 @@
 
     <%- methods.each do |method| -%>
       <div id="<%= method.aref %>" class="method-detail <%= method.is_alias_for ? "method-alias" : '' %>">
-        <%- if (call_seq = method.call_seq) then -%>
-        <%-   call_seq.strip.split("\n").each_with_index do |call_seq, i| -%>
-        <div class="method-heading">
-          <span class="method-callseq">
-            <%= h(call_seq.strip.
-                  gsub( /^\w+\./m, '')).
-                  gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
-          </span>
-          <%- if i == 0 and method.token_stream then -%>
-          <span class="method-click-advice">click to toggle source</span>
-          <%- end -%>
-        </div>
-        <%-   end -%>
-        <%- else -%>
-        <div class="method-heading">
-          <span class="method-name"><%= h method.name %></span><span
-            class="method-args"><%= h method.param_seq %></span>
-          <%- if method.token_stream then -%>
-          <span class="method-click-advice">click to toggle source</span>
+        <div class="method-header">
+          <%- if (call_seq = method.call_seq) then -%>
+          <%-   call_seq.strip.split("\n").each_with_index do |call_seq, i| -%>
+          <div class="method-heading">
+            <span class="method-callseq">
+              <%= h(call_seq.strip.
+                    gsub( /^\w+\./m, '')).
+                    gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
+            </span>
+            <%- if i == 0 and method.token_stream then -%>
+            <span class="method-click-advice">click to toggle source</span>
+            <%- end -%>
+          </div>
+          <%-   end -%>
+          <%- elsif method.has_call_seq? then -%>
+          <div class="method-heading">
+            <span class="method-name"><%= h method.name %></span>
+          </div>
+          <%- else -%>
+          <div class="method-heading">
+            <span class="method-name"><%= h method.name %></span><span
+              class="method-args"><%= h method.param_seq %></span>
+            <%- if method.token_stream then -%>
+            <span class="method-click-advice">click to toggle source</span>
+            <%- end -%>
+          </div>
           <%- end -%>
         </div>
-        <%- end -%>
 
+        <%- unless method.skip_description? then -%>
         <div class="method-description">
           <%- if method.comment then -%>
           <%= method.description.strip %>
@@ -143,6 +150,7 @@
           </div>
           <%- end -%>
         </div>
+        <%- end -%>
 
         <%- unless method.aliases.empty? then -%>
         <div class="aliases">