rdoc-markdown 0.20.0 → 0.20.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fe864809969e8bc21a90e174270ac16a0d346dc7e909b2bc621af2518bbc971
-  data.tar.gz: 8aa123afbc0ba9e29fe03e3d922636cae237183bfa0af99ac25feed38fe7eb12
+  metadata.gz: 867481b03e8cfa3279b67d5344e3d95dfed1c23b4a885cef33bf2cf0992d2df8
+  data.tar.gz: f1bea8f39ecc1ccfdb9363c8c1071fa01099cf48596c1e4d90b01dee4cd000b1
 SHA512:
-  metadata.gz: 452aa91cfc511f89e840b11b76dcaa8b6cb295acf8e20a59296f9298991d0c46a03274bc09e2e53ad56901803dd03cb36786480f574b222e547267cc1df0d9ad
-  data.tar.gz: ecabd0ada5aae3f3e0055f6cee4e8a41cf10497d13f116a05dae7863c1f6d15d3f6b4166602d947c96a7a9e624e2bcb637056feae2b083c8596c9c5675a43e4d
+  metadata.gz: 9eb94354e06c97eb71c9bf4defc1c4f4b7f62489d1ac5d9170cb2d091ab126f181b6f84457d9f2f78a324814ed417d78a9dba67f3d2a995cacfabc276cab3eba
+  data.tar.gz: 2caa21c1f0968226a68dddfb115f9dd6c8750ed08db856fb94dce541100eb7b0c2fb36ef7da355f54f5b50e15129c9b65cd19ff5e0aa597e9a65c4a955eb2e33

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 ## Unreleased
 
+## 0.20.2
+
+- Preserve documented bracket lookup and assignment arguments in method headings without changing their anchors.
+
+## 0.20.1
+
+- Don't offset headings for commets 
+
 ## 0.20.0
 
 - Restore legacy anchors in a single Markdown substitution pass.

data/lib/rdoc/generator/markdown/descriptions.rb

@@ -96,6 +96,8 @@ module RDoc::Generator::Markdown::Descriptions
     description = render_description(code_object)
     return fallback.to_s if description.empty?
 
+    comment = code_object.comment
+    heading_level_offset = 0 if RDoc::Comment === comment && comment.format == "markdown"
     RDoc::Generator::Markdown::Conversion.markdownify(description, heading_level_offset: heading_level_offset)
   end
 

data/lib/rdoc/generator/markdown/signatures.rb

@@ -11,34 +11,54 @@ module RDoc::Generator::Markdown::Signatures
   #
   # @param method [RDoc::AnyMethod] Method object to render.
   #
-  # @return [String] Normalized method signature.
+  # @return [String] Complete signature including the method name or documented receiver.
   def method_signature(method)
     RDoc::Generator::Markdown::Signatures.render_method_signature(method, store)
   end
 
   private :method_signature
 
-  # Builds a method signature from RDoc and store metadata.
+  # Builds a complete method heading signature from RDoc and store metadata.
   #
   # @param method [RDoc::AnyMethod] Method object to render.
   # @param store [RDoc::Store] Documentation store with sidecar signatures.
   #
-  # @return [String] Normalized method signature.
+  # @return [String] Complete signature including the method name or documented receiver.
   def self.render_method_signature(method, store)
-    signatures = method.type_signature_lines || store.rbs_signature_for(method) || [method.param_seq]
+    signatures = method.type_signature_lines || store.rbs_signature_for(method)
+    if !signatures && (call_seq = bracket_call_sequence(method))
+      return call_seq.lines.map { |line| normalize_signature(line) }.join(" | ")
+    end
+    signatures ||= [method.param_seq]
 
     signatures = signatures.filter_map do |signature|
       next unless signature&.match?(/\S/)
 
-      signature = signature.gsub("->", " -> ")
-      signature = signature.gsub(/\s+/, " ").strip
+      signature = normalize_signature(signature)
       signature = " #{signature}" if signature.start_with?("->")
       merge_method_signature_arguments(signature, method.params)
     end
 
-    return "()" if signatures.empty?
+    signature = signatures.empty? ? "()" : signatures.join(" | ")
+    "#{method.name}#{signature}"
+  end
 
-    signatures.join(" | ")
+  # Returns the original call syntax for bracket operators, when documented.
+  #
+  # @param method [RDoc::AnyMethod] Method object to render.
+  #
+  # @return [String, nil] Documented bracket calls, or nil for other signatures.
+  def self.bracket_call_sequence(method)
+    method.call_seq if ["[]", "[]="].include?(method.name)
+  end
+
+  # Normalizes spacing in a signature without changing its call syntax.
+  #
+  # @param signature [String] Signature or complete call sequence.
+  #
+  # @return [String] Signature with consistent arrow and whitespace formatting.
+  def self.normalize_signature(signature)
+    signature.gsub("->", " -> ").gsub(/\s+/, " ").strip
   end
 
   # Merges RDoc parameter names into a type-only signature.

data/lib/rdoc/markdown/version.rb

@@ -5,6 +5,6 @@ module Rdoc
   # @private
   module Markdown
     # @private
-    VERSION = "0.20.0"
+    VERSION = "0.20.2"
   end
 end

data/lib/templates/classfile.md.erb

@@ -61,7 +61,7 @@
 
 <%= "#" * group_heading_level %> <%= visibility.capitalize %> <%= type.capitalize %> Methods
 <% methods.each do |method| -%>
-<%= "#" * member_heading_level %> `<%= method.name %><%= method_signature(method) %>`<%= anchor(method.aref) %>
+<%= "#" * member_heading_level %> `<%= method_signature(method) %>`<%= anchor(method.aref) %>
 <%= method_description(method, current_class: klass, heading_level_offset: member_heading_level) %>
 <% end -%>
 <% end -%>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.20.2
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov