yard-markdown 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80c8051a8c7527055a46d9dcad2db56a019f54bb99315e25813a010152fd2df3
-  data.tar.gz: 7187cf79b4ea2ef53b859cb17971681eefc3981e2d3da9718dead415a2b503f2
+  metadata.gz: 63e026f1e1784ecb9ed593de1a380099db8d9e3712d20d5d3d72c1c69e199ca5
+  data.tar.gz: ee10fb76b63e7a21478cf4e9c701cf63f7634812b09c7a51dacdf4a95bc42f6c
 SHA512:
-  metadata.gz: 71b9f9638c8f7da302a2d8a412524bef3bb77aa7a0ec5f38a8cdc45fa04f4a65e34b0d6e7bb9c0b42e765c474041ec6b9a2845d7136f11552dd64e6f4fc52720
-  data.tar.gz: 6e1459ddb1e780dc708d67a1bc13d8f7315bfd8041a07c72207bf66af6bf4d9b91ce9833d7346ec78eef2708eff449932bb6d2743d4e64b8ea5bfe87d3d71e4a
+  metadata.gz: a97ef87f724a9ddeeb9ae9e62fe778a63cfd206eb2e43023848d21f3fe64e258a3a3a8ce12fc2c75534342689588cf5d1c9e1ff92dbbc97ca320f345438551ca
+  data.tar.gz: cc29ea0d44aae4d42755d90b39ebbd493ff4f1d69f0348818cd6c9adc82baaca8d7cdd2092b9f2a8131c1079b78ff5b09b3ca24dc0d4b24be8e906e74138cc11

data/CHANGELOG.md

@@ -5,6 +5,11 @@ This format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 
 ## Unreleased
 
+### 0.10.0
+
+- Render optional keyword parameters with valid Ruby syntax (for example, `read_timeout: nil` instead of `read_timeout: = nil`).
+- Preserve option names, types, descriptions, and defaults when rendering YARD `@option` tags.
+
 ## 0.9.1
 
 - Include full filenames for files, not just titles

data/README.md

@@ -2,14 +2,10 @@
 
 Yard plugin to output markdown documentation.
 
-## Motivation
-Markdown has become the de-facto documentation standard. I heavily rely on Obsidian to render my storage of markdown notes. But markdown is used not just for scribbles, supported is far and wide. We can render markdown file on any device, probably even on thermometer with a screen. But also everyone knows enough markdown to be dangerous (or productive).
-It's a pitty that rdoc and yard can't output a proper markdown file. I would like to change that.
-
 ## Goals:
 - Compatible with Github Flavored Markdown
 - Produce .csv index file
-- Mimick yard html layout where it makes sense to maintain familiarity
+- Mimick html layout where it makes sense to maintain familiarity
 
 ## Usage
 Install a plugin

data/lib/yard/markdown/method_presentation_helper.rb

@@ -21,7 +21,10 @@ module YARD
       # @return [String] Parenthesized method signature.
       def self.method_signature(method_object)
         rendered = Array(method_object.parameters).map do |name, default|
-          default.to_s.empty? ? name : "#{name} = #{default}"
+          next name if default.to_s.empty?
+
+          separator = name.end_with?(":") ? " " : " = "
+          "#{name}#{separator}#{default}"
         end
 
         "(#{rendered.join(", ")})"

data/lib/yard/markdown/tag_formatting_helper.rb

@@ -19,18 +19,24 @@ module YARD
         [regular, examples].reject(&:empty?).join("\n\n")
       end
 
-      # Formats a non-example YARD tag as a Markdown list item body.
+      # Formats a non-example YARD tag, including nested option details.
       #
       # @param tag [YARD::Tags::Tag] Non-example tag being converted into list item text.
       # @return [String] Markdown representation of the tag.
       def self.format_tag(tag)
         name = tag.name.to_s
+        if tag.tag_name == "option"
+          name = "#{name}[#{tag.pair.name}]"
+          tag = tag.pair
+          defaults = tag.defaults
+        end
         text = tag.text.to_s
         types = Array(tag.types).map { |type| type.to_s.strip }.reject(&:empty?)
         [
           "**@#{tag.tag_name}**",
           ("`#{name}`" unless name.lstrip.empty?),
           ("[#{types.join(", ")}]" unless types.empty?),
+          ("(default: `#{defaults.join(", ")}`)" if defaults),
           (text.strip unless text.lstrip.empty?)
         ].compact.join(" ")
       end

data/lib/yard/markdown/yardoc_extension.rb

@@ -11,7 +11,10 @@ module YARD
       # @param checksums [Hash, nil] Previously generated file checksums.
       # @return [void]
       def run_generate(checksums)
-        add_extra_files(markdown_files) if options.format == :markdown
+        if options.format == :markdown
+          add_extra_files(markdown_files)
+          options.serializer.extension = "md"
+        end
 
         super
       end

data/templates/default/fulldoc/markdown/setup.rb

@@ -19,8 +19,6 @@ def init
   options.delete(:objects)
   options.delete(:files)
 
-  options.serializer.extension = "md"
-
   files.each { |file| options.serializer.serialize(file.filename, File.binread(file.filename)) }
 
   objects.each do |object|
@@ -31,7 +29,7 @@ def init
     log.backtrace(e)
   end
 
-  serialize_index(objects, files)
+  serialize_index(run_verifier(YARD::Registry.all(:module, :class)), files)
 end
 
 # Renders the markdown template for a single namespace object.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard-markdown
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Stanislav (Stas) Katkov
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.19
 specification_version: 4
 summary: yard plugin to generate markdown documentation
 test_files: []