rdoc-markdown 0.21.1 → 0.21.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5103b919452fc2a8143563d54ce1c2e7ab3e4aaf2afdfe44d6057fcce9a2e5c4
-  data.tar.gz: d8abe423253297371c5cb60c722bb24507c40d2a73ee9df37eca75a1b2dab60a
+  metadata.gz: feb14b11dc71c71a4e9e0af4a71f6d074706120984b7b5c6c890c126e8894e23
+  data.tar.gz: ea5b339442fe650abae65db6f5ce051a959c361056b651cde5fb7ae2b1daf778
 SHA512:
-  metadata.gz: 3fa2a3b9e6cc98af9902d054f3ad4989e05639f9f55da4bd2d5e4f5a984d9e97833d1c4d06898439a00907ad783ec7329ad46c2c8ae614fcc46a001ceea444fd
-  data.tar.gz: dedabad24735933e97d59127de66271a2a628287822e626c6eb4c5bf9631c613c512a05a511918c4a84fed34bffa61dd29166716fe61ae4badf38fa3e9220deb
+  metadata.gz: c0a5a47ff262d233b3bebb8f2016f1f31f3a0ce106ce3d25e68f46251bed353cc5df1a26e4534a9e92159e9ee458965d0864b91f94f4c48100f4f54d012824ce
+  data.tar.gz: a95167a0eed14716ce4014cd6330c73cb546fa45a553f747e883b64f7614c54638656ce6ce76a95bc6e64ae9f9f8051ceabcfd02c30c060e8d0aa1a94aa8ac85

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+## 0.21.2
+
+- Distinguish instance methods (`Class#method`) from class methods (`Class.method`) in search-index names, without changing their document paths or anchors.
+
 ## 0.21.1
 
 - Preserve hash-prefixed comments and literal Markdown headings in code examples when offsetting documentation headings.

data/README.md

@@ -1,15 +1,8 @@
 # RDoc-Markdown
 RDoc plugin to generate markdown documentation and search index file (CSV).
 
-> [!CAUTION]
-> This gem relies on multiple hacks to generate "plausible" markdown documentation. This is **NOT PRODUCTION READY** — use at your own risk.
->
-> RDoc maintainers are actively working on markdown support, things will improve with time...
-
 ## Motivation
-Markdown has become the de facto documentation standard. We can render markdown files on any device, possibly on a thermometer with a screen. And everyone knows markdown...
-
-It's a pity that RDoc can't output a proper markdown file. Somebody has to try to build it.
+Markdown has become the de facto documentation standard. Rdoc should be able to output it too.
 
 ## Installation
 

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

@@ -34,7 +34,8 @@ module RDoc::Generator::Markdown::Index
     csv << [class_name, klass.type.capitalize, output_path]
 
     klass.method_list.select(&:display?).each do |method|
-      csv << ["#{class_name}.#{method.name}", "Method", "#{output_path}##{method.aref}"]
+      separator = method.singleton ? "." : "#"
+      csv << ["#{class_name}#{separator}#{method.name}", "Method", "#{output_path}##{method.aref}"]
     end
     klass.constants.select(&:display?).sort.each do |const|
       name = const.name

data/lib/rdoc/markdown/version.rb

@@ -5,6 +5,6 @@ module Rdoc
   # @private
   module Markdown
     # @private
-    VERSION = "0.21.1"
+    VERSION = "0.21.2"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdoc-markdown
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.21.2
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
@@ -208,7 +208,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.19
+rubygems_version: 4.0.20
 specification_version: 4
 summary: RDoc plugin to generate markdown documentation
 test_files: []