Add yard, yardstick and yard-junk to document the gem

2023-01-06 11:15:17 +07:00
parent 89a23a69e2
commit 08236c4194
4 changed files with 41 additions and 0 deletions
--- a/.yardstick.yml
+++ b/.yardstick.yml
@@ -0,0 +1,22 @@
+threshold: 100
+rules:
+  ApiTag::Presence:
+    enabled: true
+  ApiTag::Inclusion:
+    enabled: true
+  ApiTag::ProtectedMethod:
+    enabled: true
+  ApiTag::PrivateMethod:
+    enabled: true
+  ExampleTag:
+    enabled: true
+  ReturnTag:
+    enabled: true
+  Summary::Presence:
+    enabled: true
+  Summary::Length:
+    enabled: false
+  Summary::Delimiter:
+    enabled: true
+  Summary::SingleLine:
+    enabled: false