Skip to content

Commit

Permalink
fix(yard): remove colon in tags
Browse files Browse the repository at this point in the history
  • Loading branch information
marian13 committed Jun 5, 2023
1 parent cfaa324 commit 81239d7
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 17 deletions.
4 changes: 2 additions & 2 deletions lib/convenient_service/configs/minimal.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ module Configs
##
# Defines minimal configuration that adds a constructor, JSend-inspired result, steps, basic inspects, and internals to services.
#
# @note: This config is NOT intented for the end-user usage. Use `Standard` instead.
# @note This config is NOT intented for the end-user usage. Use `Standard` instead.
#
# @note:
# @note
# `use Plugins::Common::NormalizesEnv::Middleware` should be used in a config that has the first `concern` that introduces a method.
# For example, `:result` is added by `use Plugins::Service::HasResult::Concern` in `Minimal`.
# That is why the following code is written in the `Minimal` config.
Expand Down
2 changes: 1 addition & 1 deletion lib/convenient_service/core/entities/config.rb
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ def commit!(trigger: Constants::Triggers::USER)
private

##
# @note: Config is committed either by `commit_config` or `method_missing` from `ConvenientService::Core::InstanceMethods` and `ConvenientService::Core::ClassMethods`.
# @note Config is committed either by `commit_config` or `method_missing` from `ConvenientService::Core::InstanceMethods` and `ConvenientService::Core::ClassMethods`.
#
# @return [void]
# @raise [ConvenientService::Core::Entities::Config::Errors::ConfigIsCommitted]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ def configure(&configuration_block)
end

##
# @note: Works in a similar way as `Kernel.require`.
# @note Works in a similar way as `Kernel.require`.
#
# @return [Boolean]
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,16 @@ def ==(other)
# @param other [Object] Can be any type.
# @return [Boolean, nil]
#
# @note: `Code#===` allows to use RSpec expectation matchers and RSpec mocks arguments matchers for comparison.
# @note `Code#===` allows to use RSpec expectation matchers and RSpec mocks arguments matchers for comparison.
#
# @example: RSpec expectation matchers.
# @example RSpec expectation matchers.
# expect(result).to be_error.with_code(match(/bar/))
#
# @see https://rspec.info/features/3-12/rspec-mocks/setting-constraints/matching-arguments
# @see https://rspec.info/documentation/3.12/rspec-mocks/RSpec/Mocks/ArgumentMatchers.html
# @see https://github.com/rspec/rspec-mocks/blob/v3.12.3/lib/rspec/mocks/argument_matchers.rb#L282
#
# @example: RSpec mocks arguments matchers.
# @example RSpec mocks arguments matchers.
# expect(result).to be_success.with_code(instance_of(Symbol))
#
# @see https://rspec.info/features/3-12/rspec-expectations/built-in-matchers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,23 +73,23 @@ def ==(other)
# @param other [Object] Can be any type.
# @return [Boolean, nil]
#
# @note: `Data#===` allows to use RSpec expectation matchers and RSpec mocks arguments matchers for comparison.
# @note `Data#===` allows to use RSpec expectation matchers and RSpec mocks arguments matchers for comparison.
#
# @example: RSpec expectation matchers.
# @example RSpec expectation matchers.
# expect(result).to be_success.with_data(foo: match(/bar/))
#
# @see https://rspec.info/features/3-12/rspec-mocks/setting-constraints/matching-arguments
# @see https://rspec.info/documentation/3.12/rspec-mocks/RSpec/Mocks/ArgumentMatchers.html
# @see https://github.com/rspec/rspec-mocks/blob/v3.12.3/lib/rspec/mocks/argument_matchers.rb#L282
#
# @example: RSpec mocks arguments matchers.
# @example RSpec mocks arguments matchers.
# expect(result).to be_success.with_data(hash_including(:foo))
#
# @see https://rspec.info/features/3-12/rspec-expectations/built-in-matchers
# @see https://rspec.info/documentation/3.12/rspec-expectations/RSpec/Matchers/BuiltIn.html
# @see https://github.com/rspec/rspec-expectations/blob/v3.12.3/lib/rspec/matchers/composable.rb#L45
#
# @example: Combo of RSpec expectation matchers and RSpec mocks arguments.
# @example Combo of RSpec expectation matchers and RSpec mocks arguments.
# expect(result).to be_success.with_data(hash_including(foo: match(/bar/)))
#
# @internal
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,16 @@ def ==(other)
# @param other [Object] Can be any type.
# @return [Boolean, nil]
#
# @note: `Message#===` allows to use RSpec expectation matchers and RSpec mocks arguments matchers for comparison.
# @note `Message#===` allows to use RSpec expectation matchers and RSpec mocks arguments matchers for comparison.
#
# @example: RSpec expectation matchers.
# @example RSpec expectation matchers.
# expect(result).to be_failure.with_message(match(/foo/))
#
# @see https://rspec.info/features/3-12/rspec-mocks/setting-constraints/matching-arguments
# @see https://rspec.info/documentation/3.12/rspec-mocks/RSpec/Mocks/ArgumentMatchers.html
# @see https://github.com/rspec/rspec-mocks/blob/v3.12.3/lib/rspec/mocks/argument_matchers.rb#L282
#
# @example: RSpec mocks arguments matchers.
# @example RSpec mocks arguments matchers.
# expect(result).to be_failure.with_message(instance_of(String))
#
# @see https://rspec.info/features/3-12/rspec-expectations/built-in-matchers
Expand Down
2 changes: 1 addition & 1 deletion lib/convenient_service/utils/hash/assert_valid_keys.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

##
# @example:
# @example
# ConvenientService::Utils::Hash::AssertValidKeys.call({foo: "foo", bar: "bar"}, [:foo, :bar])
#
module ConvenientService
Expand Down
2 changes: 1 addition & 1 deletion lib/convenient_service/utils/hash/except.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# frozen_string_literal: true

##
# @example:
# @example
# ConvenientService::Utils::Hash::Except.call({foo: :bar, baz: :qux}, [:foo])
#
module ConvenientService
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ module Object
# Can be used instead of `return @ivar if defined? @ivar`.
# @see https://www.justinweiss.com/articles/4-simple-memoization-patterns-in-ruby-and-one-gem/
#
# @note: `false` and `nil` are the only values that are considered `falsy` in Ruby.
# @note `false` and `nil` are the only values that are considered `falsy` in Ruby.
# @see https://riptutorial.com/ruby/example/2092/truthy-and-falsy-values
# @see https://www.ruby-lang.org/en/documentation/faq/6/
#
Expand Down

0 comments on commit 81239d7

Please sign in to comment.