rubocop-yardoc 0.2.0 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -0
  3. data/README.md +1 -7
  4. data/cops.adoc +823 -0
  5. data/lib/rubocop/cop/mixin/param_help.rb +8 -7
  6. data/lib/rubocop/cop/yardoc/class_description.rb +19 -10
  7. data/lib/rubocop/cop/yardoc/column_params.rb +5 -1
  8. data/lib/rubocop/cop/yardoc/constant_description.rb +16 -5
  9. data/lib/rubocop/cop/yardoc/method_description.rb +37 -11
  10. data/lib/rubocop/cop/yardoc/module_description.rb +20 -12
  11. data/lib/rubocop/cop/yardoc/param_description_casing.rb +3 -1
  12. data/lib/rubocop/cop/yardoc/param_documentation.rb +6 -3
  13. data/lib/rubocop/cop/yardoc/separate_tags_blocks.rb +3 -1
  14. data/lib/rubocop/cop/yardoc/supported_tags.rb +9 -6
  15. data/lib/rubocop/cop/yardoc/tag_order.rb +6 -2
  16. data/lib/rubocop/cop/yardoc/types_format.rb +4 -2
  17. data/lib/rubocop/cop/yardoc/valid_types.rb +4 -4
  18. data/lib/rubocop/cop/yardoc/yield_documentation.rb +8 -4
  19. data/lib/rubocop/cop/yardoc_base.rb +62 -0
  20. data/lib/rubocop/cop/yardoc_cops.rb +1 -1
  21. data/lib/rubocop/yardoc/version.rb +1 -1
  22. metadata +4 -3
  23. data/lib/rubocop/cop/yardoc/base.rb +0 -64
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b85c7c55d0d3f08bf5634b5275d57a4f4951984bb49df452621ea8314a742ff9
4
- data.tar.gz: 215d8421801cb366a8193d2e7b706977dbb3512ca6614e6a7f0a15b4501b784c
3
+ metadata.gz: f5e0e2d52e0f25ed5d9b2cff8dd1ca86e4651a0b33da17940983c5effd00bbe5
4
+ data.tar.gz: 595d972611c298f97c0b8ad56a71da8aebf8dec24e38b4edff10f964611c93cf
5
5
  SHA512:
6
- metadata.gz: 017eb5da65048d4090b71e58fc737201c6f709f7f6cbb9fb8c95a0df547eb5a20ea47f5e0eddf1f6c02893ef2a85a82228b88a1082c1d7bb0a375a1f980974f2
7
- data.tar.gz: 42df0fcef20c8a6f3a6c419343e5a00ab8cd51fb24bb68012e1da624af798bc0c15b76d18b01b381e2cff79dd652e854886094df534c9196c22d5c05d2623e86
6
+ metadata.gz: 2e0d2a8f7d9b0355432ec49ac207856ea810f1bcff0d54e7491128593cf2c7fd1fd1e43e9d2fd8ff556f127e2f7904fa79fef257ad679a9c62dd6f909aa168ac
7
+ data.tar.gz: a302d5782838ee4cd622f5bc8c37d69cc0136f9c562d9e8816725c675b329f7f462f5f826b1398c7bbefe5117545eaae3822bf633a86c0da9b50c4c4f0e5cf10
data/CHANGELOG.md CHANGED
@@ -1,5 +1,18 @@
1
1
  ## [Unreleased]
2
2
 
3
+ ## [0.2.2] - 2026-08-10
4
+
5
+ ### Fixed
6
+
7
+ - Fixed incorrect param tag matching when two params starts with the same string (e.g.: `@param line` and `@param lines`)
8
+
9
+ ## [0.2.1] - 2026-08-05
10
+
11
+ ### Fixed
12
+
13
+ - Invalid imbricated types are now matched against YARD types (no more issues with types like `[String, Array[String]]`)
14
+ - `Yardoc/MethodDescription` is now triggered when method docblock contains only tags
15
+
3
16
  ## [0.2.0] - 2026-08-04
4
17
 
5
18
  ### Added
data/README.md CHANGED
@@ -13,9 +13,7 @@ A RuboCop plugin to lint documentation comments in Ruby files.
13
13
  - Development-related:
14
14
  - [Contribution guide](CONTRIBUTING.md)
15
15
  - _This file_
16
- - Provided cops: **For now, refer to examples in `lib/rubocop/cop/yardoc/*`.**
17
-
18
- _Todo_ : Gitlab pages with cop documentation, Markdown cop documentation from sources.
16
+ - Provided cops: [cops.adoc](./cops.adoc)
19
17
 
20
18
  ## Installation
21
19
 
@@ -43,10 +41,6 @@ plugins:
43
41
 
44
42
  Then, run RuboCop as usual.
45
43
 
46
- ## Cops
47
-
48
- _TODO_
49
-
50
44
  ## Development
51
45
 
52
46
  After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can