Skip to content

Commit

Permalink
Improve documentation wording and formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
jeromedalbert committed Oct 27, 2024
1 parent f22db5d commit a12d6b9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
3 changes: 2 additions & 1 deletion lib/rubocop/cop/obsession/method_order.rb
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
module RuboCop
module Cop
module Obsession
# This cop checks for private/protected methods that are not ordered correctly.
# This cop checks for private/protected methods that are not ordered
# correctly. It supports autocorrect.
#
# Code should read from top to bottom: methods should be defined in the
# same order as the order when they are first mentioned.
Expand Down
10 changes: 5 additions & 5 deletions lib/rubocop/cop/obsession/rails/fully_defined_json_field.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ module Rails
# defaults or comments.
#
# - json(b) fields should have a default value like {} or [] so code can
# do my_field['field'] or my_field.first without fear that my_field is
# nil.
# do my_field['field'] or my_field.first without fear that my_field is
# nil.
# - It is impossible to know the structure of a json(b) field just by
# reading the schema, because json(b) is an unstructured type. That's why
# an "Example: ..." Postgres comment should always be present when
# defining the field.
# reading the schema, because json(b) is an unstructured type. That's why
# an "Example: ..." Postgres comment should always be present when
# defining the field.
#
# @example
#
Expand Down

0 comments on commit a12d6b9

Please sign in to comment.