sord 5.0.1 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84021ad2fe6eca96e0b11e2ebc8b41fb7070c9e8bcd32db11e39fafecd463d86
-  data.tar.gz: a38b1025856359aff335bcac403a563ac1cbe526c2c6edb8ab3d3c6e1088af02
+  metadata.gz: f101fdc3b63cf69bc59fd766ced5222c3e6b02f70f913fcc39085459e32c89de
+  data.tar.gz: ea8df6949fdef290b13cf082c364138a17224deb127e069fd8a55d8e86de29c4
 SHA512:
-  metadata.gz: 9857df42edf887fc03ba10d21acd9389e6d7d87427424e5881f58eee004fabb0e644cb4bad1c487ce716af712d0208f170f7f6eafd0d6f01bc853cdf3a319ffe
-  data.tar.gz: 30195da215e3a1dcba962a441e1498733ab410c59e9b6f4eab5f56be524131c0050ec150ce37b616c3d1ce2125d6b85f7cf00fe7b2b0f5a95c5eb99525736c8e
+  metadata.gz: 9bed3f4e28d753ccf493a63d552f0560267d5a4841ca6208691e557fa84ba719e1c906be765c4ba45d62ad84cbe167766b8b286202727400bcf62bf8e0748a84
+  data.tar.gz: c51d9041a3de3dd66faf35173c38ce74e89e5dc4054e9cc675c54a871dc35c84a33139e1a18674265d951f759365a66f272badca1306d89c3b7fa7997f87bb3e

data/CHANGELOG.md

@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [5.1.0] - 2023-05-22
+### Added
+- Add support for a single `@overload` tag, typically used to describe methods defined outside of
+  Ruby. Thanks @ohai!
+
 ## [5.0.1] - 2023-05-02
 ### Fixed
 - Use `File#exist?` instead of `File#exists?`, for Ruby 3.2 support. Thanks @matmorel!

data/lib/sord/generator.rb

@@ -294,6 +294,15 @@ module Sord
           next
         end
 
+        # If the method has YARD's "@overload" tags, the information of the
+        # first one is merged into meth object
+        # NOTE: This code does not handle the second and subsequent @overload tags
+        if meth.tag("overload")
+          meth.parameters = meth.tag("overload").parameters
+          meth.tag("overload").tags.each { |tag| meth.add_tag(tag) }
+          meth.docstring += meth.tag("overload").docstring
+        end
+        
         # Sort parameters
         meth.parameters.reverse.sort! { |pair1, pair2| sort_params(pair1, pair2) }
 

data/lib/sord/version.rb

@@ -1,4 +1,4 @@
 # typed: strong
 module Sord
-  VERSION = '5.0.1'
+  VERSION = '5.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sord
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.1.0
 platform: ruby
 authors:
 - Aaron Christiansen
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard