Skip to content

Commit

Permalink
docs(tldr_example): rename for: to method:
Browse files Browse the repository at this point in the history
  • Loading branch information
marian13 committed Oct 1, 2022
1 parent 26b215e commit 38ad576
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ This library is under heavy development. Public API may be subject to change. Th
use ConvenientService::Plugins::Common::AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment::Concern
end

middlewares for: :initialize do
middlewares method: :initialize do
use ConvenientService::Plugins::Common::AssignsAttributesInConstructor::UsingActiveModelAttributeAssignment::Middleware
end

Expand All @@ -218,7 +218,7 @@ This library is under heavy development. Public API may be subject to change. Th
use ConvenientService::Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Concern
end

middlewares for: :result do
middlewares method: :result do
use ConvenientService::Plugins::Service::HasResultParamsValidations::UsingActiveModelValidations::Middleware
end

Expand Down Expand Up @@ -355,7 +355,7 @@ This library is under heavy development. Public API may be subject to change. Th
use ConvenientService::Plugins::Service::HasResultParamsValidations::UsingDryValidation::Concern
end

middlewares for: :result do
middlewares method: :result do
use ConvenientService::Plugins::Service::HasResultParamsValidations::UsingDryValidation::Middleware
end

Expand Down
1 change: 1 addition & 0 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@
| High | 🚧 | `respond_to_missing?` | |
| Medium || Custom matcher to track `ConvenientService::Logger` messages | |
| Medium | 🚧 | Remove `respond_to?` from `Copyable` | Investigate before making any decision |
| High | 🚧 | Unified `inspect` | |
8 changes: 4 additions & 4 deletions lib/convenient_service/core/class_methods.rb
Original file line number Diff line number Diff line change
Expand Up @@ -48,25 +48,25 @@ def concerns(&configuration_block)
#
# @overload middlewares(method:)
# Returns all instance middlewares for particular method.
# @param for [Symbol] Method name.
# @param method [Symbol] Method name.
# @return [Hash<Symbol, Hash<Symbol, ConvenientService::Core::Entities::MethodMiddlewares>>]
#
# @overload middlewares(method:, scope:)
# Returns all scoped middlewares for particular method.
# @param for [Symbol] Method name.
# @param method [Symbol] Method name.
# @param scope [:instance, :class]
# @return [Hash<Symbol, Hash<Symbol, ConvenientService::Core::Entities::MethodMiddlewares>>]
#
# @overload middlewares(method:, &configuration_block)
# Configures instance middlewares for particular method.
# @param for [Symbol] Method name.
# @param method [Symbol] Method name.
# @param configuration_block [Proc] Block that configures middlewares.
# @see https://github.com/marian13/ruby-middleware#a-basic-example
# @return [ConvenientService::Core::Entities::MethodMiddlewares]
#
# @overload middlewares(method:, scope:, &configuration_block)
# Configures scoped middlewares for particular method.
# @param for [Symbol] Method name.
# @param method [Symbol] Method name.
# @param scope [:instance, :class]
# @param configuration_block [Proc] Block that configures middlewares.
# @see https://github.com/marian13/ruby-middleware#a-basic-example
Expand Down

0 comments on commit 38ad576

Please sign in to comment.