Skip to content

Commit

Permalink
Improve documentation wording
Browse files Browse the repository at this point in the history
  • Loading branch information
jeromedalbert committed Oct 28, 2024
1 parent c85ea64 commit 940af39
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion lib/rubocop/cop/obsession/no_paragraphs.rb
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ module Obsession
# If your method code has many instructions that are not organized into
# paragraphs, you should break it up into multiple paragraphs to make the
# code more breathable and readable. The 3 possible paragraphs themes
# always are: initialization, action, and result.
# could be: initialization, action, and result.
#
# @example
#
Expand Down
6 changes: 3 additions & 3 deletions lib/rubocop/cop/obsession/too_many_paragraphs.rb
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ module Obsession
# This cop checks for methods with too many paragraphs.
#
# You should organize your method code into 2 to 3 paragraphs maximum.
# The 3 possible paragraphs themes always are: initialization, action,
# The 3 possible paragraphs themes could be: initialization, action,
# and result. Shape your paragraph according to those themes. Spec code
# should also be organized into 2 to 3 paragraphs
# (initialization/action/result or given/when/then paragraphs).
#
# After organizing your paragraphs, if they are too long or dense, it is
# a sign that you should break your code into smaller methods.
# After organizing your paragraphs, if they are too long or dense, it
# could be a sign that they should be broken into smaller methods.
#
# @example
#
Expand Down

0 comments on commit 940af39

Please sign in to comment.