Skip to content

Commit 86e0b88

Browse files
committed
Add blank line separators to YARD doc comments
Enabled the TagGroupSeparator rule in .yard-lint.yml and added blank lines between YARD tag groups in documentation comments for improved readability and lint compliance.
1 parent 6ca28a1 commit 86e0b88

5 files changed

Lines changed: 7 additions & 1 deletion

File tree

.yard-lint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ Tags/NonAsciiType:
234234

235235
Tags/TagGroupSeparator:
236236
Description: 'Enforces blank line separators between different YARD tag groups.'
237-
Enabled: false # Opt-in validator
237+
Enabled: true # Opt-in validator
238238
Severity: error
239239
TagGroups:
240240
param: [param, option]

lib/jsonrpc/configuration.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ class Configuration
2626
#
2727
# @example
2828
# procedure.allow_positional_arguments # => true
29+
#
2930
# @return [Boolean] whether the procedure accepts positional arguments
3031
#
3132
# @!method contract
@@ -34,6 +35,7 @@ class Configuration
3435
#
3536
# @example
3637
# procedure.contract # => #<Dry::Validation::Contract...>
38+
#
3739
# @return [Dry::Validation::Contract] the validation contract for procedure parameters
3840
#
3941
# @!method parameter_name
@@ -42,6 +44,7 @@ class Configuration
4244
#
4345
# @example
4446
# procedure.parameter_name # => :numbers
47+
#
4548
# @return [Symbol, nil] the name of the first parameter in the contract schema
4649
#
4750
Procedure = Data.define(:allow_positional_arguments, :contract, :parameter_name)

lib/jsonrpc/railtie/batch_constraint.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ class BatchConstraint
1313
# Check if the request is a JSON-RPC batch request
1414
#
1515
# @param request [ActionDispatch::Request] The Rails request object
16+
#
1617
# @return [Boolean] true if the request is a batch request, false otherwise
1718
#
1819
def matches?(request)

lib/jsonrpc/railtie/method_constraint.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ def initialize(jsonrpc_method_name)
2222
# Check if the request matches the configured method name
2323
#
2424
# @param request [ActionDispatch::Request] The Rails request object
25+
#
2526
# @return [Boolean] true if the JSON-RPC method matches, false otherwise
2627
#
2728
def matches?(request)

lib/jsonrpc/railtie/routes_dsl.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ def namespace(name, &)
134134
# Build the full method name including namespaces
135135
#
136136
# @param method_name [String] the base method name
137+
#
137138
# @return [String] the full method name with namespace prefixes
138139
#
139140
def build_full_method_name(method_name)

0 commit comments

Comments
 (0)