Class: Yardstick::Rules::ApiTag::Inclusion

Inherits:
Yardstick::Rule show all
Defined in:
lib/yardstick/rules/api_tag.rb

Overview

Checks if @api tag is a public, semipublic or private

Constant Summary collapse

VALID_VALUES =
%w[ public semipublic private ].freeze

Instance Attribute Summary

Attributes inherited from Yardstick::Rule

#document

Instance Method Summary collapse

Methods inherited from Yardstick::Rule

coerce, #enabled?, #initialize, #validatable?

Constructor Details

This class inherits a constructor from Yardstick::Rule

Instance Method Details

#valid?Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns true if valid.

Returns:

  • (Boolean)

    true if valid

See Also:

  • description

37
38
39
# File 'lib/yardstick/rules/api_tag.rb', line 37

def valid?
  VALID_VALUES.include?(tag_text('api'))
end