rubocop-yardoc 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b85c7c55d0d3f08bf5634b5275d57a4f4951984bb49df452621ea8314a742ff9
-  data.tar.gz: 215d8421801cb366a8193d2e7b706977dbb3512ca6614e6a7f0a15b4501b784c
+  metadata.gz: ae6135fb00a957f05b45252a231081fe7f8762852c356cc49f005cec037590bb
+  data.tar.gz: aca1dea648fef75882180b08aaac256ec3ed5bf581439e9af967341642853b52
 SHA512:
-  metadata.gz: 017eb5da65048d4090b71e58fc737201c6f709f7f6cbb9fb8c95a0df547eb5a20ea47f5e0eddf1f6c02893ef2a85a82228b88a1082c1d7bb0a375a1f980974f2
-  data.tar.gz: 42df0fcef20c8a6f3a6c419343e5a00ab8cd51fb24bb68012e1da624af798bc0c15b76d18b01b381e2cff79dd652e854886094df534c9196c22d5c05d2623e86
+  metadata.gz: 3cf382dd7db93eff39c8973cbacf6f9400afc4baf6e8d10664f5491fe90963fea2b04ac4d2f928a7518a13ca265ce89617bf2eafbdae021f7c55eba50c04a9c9
+  data.tar.gz: 9a5688d108962d66c7f44efc5bbd890d71ab3d49f2c684e682b5b8932879b54b82938b15ebcc482e98ec71446e89d0bc4edcea42080772c691b4baba12e0791c

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [0.2.1] - 2026-08-05
+
+### Fixed
+
+- Invalid imbricated types are now matched against YARD types (no more issues with types like `[String, Array[String]]`)
+- `Yardoc/MethodDescription` is now triggered when method docblock contains only tags
+
 ## [0.2.0] - 2026-08-04
 
 ### Added

data/lib/rubocop/cop/mixin/param_help.rb

@@ -4,9 +4,6 @@ module RuboCop
   module Cop
     # Helper methods to work with node parameters
     module ParamHelp
-      # Matches the [<types>] part of a @param line
-      COMMENT_TYPES_REGEX = /^[^\[]+\[([^\[]*)\]/
-
       # "@param" tag with data from Yard and parsed source code
       #
       # @param name [String]  Parameter name
@@ -89,14 +86,16 @@ module RuboCop
                              end
             description_lines = yard_tag.text ? yard_tag.text.split("\n") : []
 
-            types_s = source_comment.text.match(COMMENT_TYPES_REGEX)
+            types = yard_tag.types || []
+            # Build the regexp with types matched by YARD so we don't have to bother with invalid brackets
+            types_s = source_comment.text.match(/\[(#{types.map { |t| Regexp.escape t }.join(',\\s*')})\]/)
             types_s = types_s ? types_s[1] : ''
 
             desc_pos = description_lines.any? ? source_comment.text.index(description_lines.first) : nil
 
             ParameterTag.new name:              yard_tag.name,
                              tag_source_line:   source_comment,
-                             types:             yard_tag.types || [],
+                             types:             types,
                              types_s:           types_s,
                              tag_range:         start_tag_position(source_comment, yard_tag.tag_name),
                              type_range:        start_type_position(source_comment, types_s),

data/lib/rubocop/cop/yardoc/method_description.rb

@@ -62,19 +62,21 @@ module RuboCop
       class MethodDescription < Base
         include VisibilityHelp
         include NodeNameHelp
+        include YardHelp
 
         MSG = 'Missing YARD documentation for method `%<name>s`.'
 
         # Executed for each method definition
         #
         # @param node [RuboCop::AST::Node] The AST node
-        def on_def(node)
+        def on_def(node) # rubocop:disable Metrics/AbcSize
           name = node.method_name.to_s
           full_name = fully_qualified_name(node)
           full_name += "::#{name}"
           return if ignored?(name, ignore_list) || ignored?(full_name, ignore_list)
           return if skip_private? && node_visibility(node) == :private
-          return if documented?(node)
+
+          return if documented?(node) && !yard_docstring(node).text.strip.empty?
 
           add_offense(node, message: format(MSG, name: name))
         end

data/lib/rubocop/yardoc/version.rb

@@ -3,6 +3,6 @@
 module RuboCop
   module Yardoc
     # Library version
-    VERSION = '0.2.0'
+    VERSION = '0.2.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-yardoc
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Manuel Tancoigne
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-08-04 00:00:00.000000000 Z
+date: 2026-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lint_roller