stretchy-model 0.6.5 → 0.6.6

data/lib/stretchy/attributes/type/numeric/half_float.rb

@@ -1,4 +1,24 @@
 module Stretchy::Attributes::Type::Numeric
+  # The HalfFloat attribute type
+  #
+  # This class is used to define a half_float attribute for a model. It provides support for the Elasticsearch numeric data type, which is a type of data type that can hold half-precision 16-bit IEEE 754 floating point values.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:half_float`.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a half_float attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
+  #     attribute :rating, :half_float
+  #   end
+  # ```
+  #
   class HalfFloat < Base
     def type
       :half_float

data/lib/stretchy/attributes/type/numeric/integer.rb

@@ -1,5 +1,25 @@
 module Stretchy::Attributes::Type::Numeric
-  class Integer < Stretchy::Attributes::Type::Base # :nodoc:
+  # The HalfFloat attribute type
+  #
+  # This class is used to define a half_float attribute for a model. It provides support for the Elasticsearch numeric data type, which is a type of data type that can hold half-precision 16-bit IEEE 754 floating point values.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:half_float`.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a half_float attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
+  #     attribute :rating, :half_float
+  #   end
+  # ```
+  #
+  class Integer < Base 
     def type
       :integer
     end

data/lib/stretchy/attributes/type/numeric/long.rb

@@ -1,4 +1,24 @@
 module Stretchy::Attributes::Type::Numeric
+  # The Long attribute type
+  #
+  # This class is used to define a long attribute for a model. It provides support for the Elasticsearch numeric data type, which is a type of data type that can hold long integer values.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:long`.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a long attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
+  #     attribute :population, :long
+  #   end
+  # ```
+  #
   class Long < Base
     def type
       :long

data/lib/stretchy/attributes/type/numeric/scaled_float.rb

@@ -1,18 +1,27 @@
 module Stretchy::Attributes::Type::Numeric
 
-  # Public: Defines a scaled_float attribute for the model.
+  # The ScaledFloat attribute type
   #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :scaling_factor - The Integer scaling factor to use when encoding values. This parameter is required.
+  # This class is used to define a scaled_float attribute for a model. It provides support for the Elasticsearch numeric data type, which is a type of data type that can hold floating point values scaled by a fixed double precision factor.
   #
-  # Examples
+  # ### Parameters
   #
-  #   class MyModel
-  #     include StretchyModel
+  # - `type:` `:scaled_float`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:scaling_factor:` The Integer scaling factor to use when encoding values. This parameter is required.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a scaled_float attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :rating, :scaled_float, scaling_factor: 10
   #   end
+  # ```
   #
-  # Returns nothing.
   class ScaledFloat < Base
     OPTIONS = Base::OPTIONS + [:scaling_factor]
 

data/lib/stretchy/attributes/type/numeric/short.rb

@@ -1,4 +1,24 @@
 module Stretchy::Attributes::Type::Numeric
+  # The Short attribute type
+  #
+  # This class is used to define a short attribute for a model. It provides support for the Elasticsearch numeric data type, which is a type of data type that can hold short integer values.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:short`.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a short attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
+  #     attribute :short_number, :short
+  #   end
+  # ```
+  #
   class Short < Base
     def type
       :short

data/lib/stretchy/attributes/type/numeric/unsigned_long.rb

@@ -1,5 +1,25 @@
 module Stretchy::Attributes::Type::Numeric
-  class UnsignedLong < Stretchy::Attributes::Type::Numeric::Base
+  # The UnsignedLong attribute type
+  #
+  # This class is used to define an unsigned_long attribute for a model. It provides support for the Elasticsearch numeric data type, which is a type of data type that can hold unsigned long integer values.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:unsigned_long`.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define an unsigned_long attribute
+  #
+  # ```ruby
+  #   class MyModel < Stretchy::Record
+  #     attribute :large_number, :unsigned_long
+  #   end
+  # ```
+  #
+  class UnsignedLong < Base
     def type
       :unsigned_long
     end

data/lib/stretchy/attributes/type/percolator.rb

@@ -1,5 +1,7 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a percolator attribute for the model.
+  # The Percolator attribute type
+  #
+  # This class is used to define a percolator attribute for a model. 
   #
   # The percolator field type parses a JSON structure into a native query and stores that query,
   # so that the percolate query can use it to match provided documents.
@@ -8,13 +10,23 @@ module Stretchy::Attributes::Type
   # The percolator field type has no settings. Just configuring the percolator field type
   # is sufficient to instruct Elasticsearch to treat a field as a query.
   #
-  # Examples
+  # ### Parameters
+  #
+  # - `type:` `:percolator`.
+  # - `options:` The Hash of options for the attribute. This type does not have any specific options.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a percolator attribute
   #
-  #   class MyModel < Stretchy::Record
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :query, :percolator
   #   end
+  # ```
   #
-  # Returns nothing.
   class Percolator < Stretchy::Attributes::Type::Base
     def type
       :percolator

data/lib/stretchy/attributes/type/point.rb

@@ -1,19 +1,29 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a point attribute for the model.
+  # The Point attribute type
   #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :ignore_malformed - The Boolean indicating if malformed points should be ignored. Defaults to false.
-  #        :ignore_z_value - The Boolean indicating if the z value of three dimension points should be ignored. Defaults to true.
-  #        :null_value - The Point value to be substituted for any explicit null values. Defaults to null.
+  # This class is used to define a point attribute for a model. It provides support for the Elasticsearch point data type, which is
+  #  a type of data type that can hold geographical points (latitude and longitude).
   #
-  # Examples
+  # ### Parameters
   #
-  #   class MyModel
-  #     include StretchyModel
+  # - `type:` `:point`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:ignore_malformed:` The Boolean indicating if malformed points should be ignored. Defaults to false.
+  #    - `:ignore_z_value:` The Boolean indicating if the z value of three dimension points should be ignored. Defaults to true.
+  #    - `:null_value:` The Point value to be substituted for any explicit null values. Defaults to null.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a point attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :location, :point, ignore_malformed: true
   #   end
+  # ```
   #
-  # Returns nothing.
   class Point < Stretchy::Attributes::Type::Base
     OPTIONS = [:ignore_malformed, :ignore_z_value, :null_value]
 

data/lib/stretchy/attributes/type/range/base.rb

@@ -1,5 +1,28 @@
 module Stretchy::Attributes::Type::Range
-  class Base < Stretchy::Attributes::Type::Base
+  # The Base class for range attribute types
+  #
+  # This class is used to define a base for range attribute types for a model. It provides support for the Elasticsearch range data types, which are types of data that can hold range of values.
+  #
+  # ### Parameters
+  #
+  # - `options:` The Hash of options for the attribute.
+  #    - `:coerce:` The Boolean indicating if strings should be converted to numbers and fractions truncated for integers. Defaults to true.
+  #    - `:index:` The Boolean indicating if the field should be quickly searchable. Defaults to true.
+  #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a range attribute
+  #
+  # ```ruby
+  #   class MyModel < Stretchy::Record
+  #     attribute :age_range, :integer_range, coerce: false
+  #   end
+  # ```
+  #
+  class Base < Stretchy::Attributes::Type::Base #:nodoc:
     OPTIONS = [:coerce, :index, :store]
 
     def type

data/lib/stretchy/attributes/type/range/date_range.rb

@@ -1,13 +1,29 @@
 module Stretchy::Attributes::Type::Range
-  # Public: Defines a date_range attribute for the model.
+  # The Range attribute type
   #
-  # Examples
+  # This class is used to define a range attribute for a model. It provides support for the Elasticsearch range data type, which is a type of data type that can hold range of values.
   #
-  #   class MyModel < Stretchy::Record
-  #     attribute :birth_date_range, :date_range
+  # ### Parameters
+  #
+  # - `type:` `:range`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:doc_values:` The Boolean indicating if the field should be stored on disk in a column-stride fashion. This allows it to be used later for sorting, aggregations, or scripting. Defaults to true.
+  #    - `:index:` The Boolean indicating if the field should be searchable. Defaults to true.
+  #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  #    - `:coerce:` The Boolean indicating if the field should automatically coerce the values to the data type. Defaults to true.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a range attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
+  #     attribute :age_range, :range
   #   end
+  # ```
   #
-  # Returns nothing.
   class DateRange < Base
 
     def type

data/lib/stretchy/attributes/type/range/double_range.rb

@@ -1,13 +1,29 @@
 module Stretchy::Attributes::Type::Range
-  # Public: Defines a double_range attribute for the model.
+  # The DoubleRange attribute type
   #
-  # Examples
+  # This class is used to define a double_range attribute for a model. It provides support for the Elasticsearch range data type, which is a type of data type that can hold range of double values.
   #
-  #   class MyModel < Stretchy::Record
+  # ### Parameters
+  #
+  # - `type:` `:double_range`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:doc_values:` The Boolean indicating if the field should be stored on disk in a column-stride fashion. This allows it to be used later for sorting, aggregations, or scripting. Defaults to true.
+  #    - `:index:` The Boolean indicating if the field should be searchable. Defaults to true.
+  #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  #    - `:coerce:` The Boolean indicating if the field should automatically coerce the values to the data type. Defaults to true.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a double_range attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :weight_range, :double_range
   #   end
+  # ```
   #
-  # Returns nothing.
   class DoubleRange < Base
 
     def type

data/lib/stretchy/attributes/type/range/float_range.rb

@@ -1,13 +1,29 @@
 module Stretchy::Attributes::Type::Range
-  # Public: Defines a float_range attribute for the model.
+  # The DoubleRange attribute type
   #
-  # Examples
+  # This class is used to define a double_range attribute for a model. It provides support for the Elasticsearch range data type, which is a type of data type that can hold range of double values.
   #
-  #   class MyModel < Stretchy::Record
-  #     attribute :rating_range, :float_range
+  # ### Parameters
+  #
+  # - `type:` `:double_range`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:doc_values:` The Boolean indicating if the field should be stored on disk in a column-stride fashion. This allows it to be used later for sorting, aggregations, or scripting. Defaults to true.
+  #    - `:index:` The Boolean indicating if the field should be searchable. Defaults to true.
+  #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  #    - `:coerce:` The Boolean indicating if the field should automatically coerce the values to the data type. Defaults to true.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a double_range attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
+  #     attribute :weight_range, :double_range
   #   end
+  # ```
   #
-  # Returns nothing.
   class FloatRange < Base
     def type
       :float_range

data/lib/stretchy/attributes/type/range/integer_range.rb

@@ -1,13 +1,29 @@
 module Stretchy::Attributes::Type::Range
-  # Public: Defines an integer_range attribute for the model.
+  # The IntegerRange attribute type
   #
-  # Examples
+  # This class is used to define an integer_range attribute for a model. It provides support for the Elasticsearch range data type, which is a type of data type that can hold range of integer values.
   #
-  #   class MyModel < Stretchy::Record
+  # ### Parameters
+  #
+  # - `type:` `:integer_range`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:doc_values:` The Boolean indicating if the field should be stored on disk in a column-stride fashion. This allows it to be used later for sorting, aggregations, or scripting. Defaults to true.
+  #    - `:index:` The Boolean indicating if the field should be searchable. Defaults to true.
+  #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  #    - `:coerce:` The Boolean indicating if the field should automatically coerce the values to the data type. Defaults to true.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define an integer_range attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :age_range, :integer_range
   #   end
+  # ```
   #
-  # Returns nothing.
   class IntegerRange < Base
     def type
       :integer_range

data/lib/stretchy/attributes/type/range/ip_range.rb

@@ -1,13 +1,29 @@
 module Stretchy::Attributes::Type::Range
-  # Public: Defines an ip_range attribute for the model.
+  # The IpRange attribute type
   #
-  # Examples
+  # This class is used to define an ip_range attribute for a model. It provides support for the Elasticsearch range data type, which is a type of data type that can hold range of IP values.
   #
-  #   class MyModel < Stretchy::Record
+  # ### Parameters
+  #
+  # - `type:` `:ip_range`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:doc_values:` The Boolean indicating if the field should be stored on disk in a column-stride fashion. This allows it to be used later for sorting, aggregations, or scripting. Defaults to true.
+  #    - `:index:` The Boolean indicating if the field should be searchable. Defaults to true.
+  #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  #    - `:coerce:` The Boolean indicating if the field should automatically coerce the values to the data type. Defaults to true.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define an ip_range attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :ip_range, :ip_range
   #   end
+  # ```
   #
-  # Returns nothing.
   class IpRange < Base
     def type
       :ip_range

data/lib/stretchy/attributes/type/range/long_range.rb

@@ -1,13 +1,29 @@
 module Stretchy::Attributes::Type::Range
-  # Public: Defines a long_range attribute for the model.
+  # The LongRange attribute type
   #
-  # Examples
+  # This class is used to define a long_range attribute for a model. It provides support for the Elasticsearch range data type, which is a type of data type that can hold range of long integer values.
   #
-  #   class MyModel < Stretchy::Record
+  # ### Parameters
+  #
+  # - `type:` `:long_range`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:doc_values:` The Boolean indicating if the field should be stored on disk in a column-stride fashion. This allows it to be used later for sorting, aggregations, or scripting. Defaults to true.
+  #    - `:index:` The Boolean indicating if the field should be searchable. Defaults to true.
+  #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  #    - `:coerce:` The Boolean indicating if the field should automatically coerce the values to the data type. Defaults to true.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a long_range attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :population_range, :long_range
   #   end
+  # ```
   #
-  # Returns nothing.
   class LongRange < Base
     def type
       :long_range

data/lib/stretchy/attributes/type/rank_feature.rb

@@ -1,16 +1,26 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a rank_feature attribute for the model.
+  # The RankFeature attribute type
   #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :positive_score_impact - The Boolean indicating if features correlate positively with the score. If set to false, the score decreases with the value of the feature instead of increasing. Defaults to true.
+  # This class is used to define a rank_feature attribute for a model. It provides support for the Elasticsearch rank_feature data type, which is a type of data type that can hold numerical features that should impact the relevance score of the documents.
   #
-  # Examples
+  # ### Parameters
   #
-  #   class MyModel < Stretchy::Record
+  # - `type:` `:rank_feature`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:positive_score_impact:` The Boolean indicating if features correlate positively with the score. If set to false, the score decreases with the value of the feature instead of increasing. Defaults to true.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a rank_feature attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :url_length, :rank_feature, positive_score_impact: false
   #   end
+  # ```
   #
-  # Returns nothing.
   class RankFeature < Stretchy::Attributes::Type::Base
     OPTIONS = [:positive_score_impact]
 

data/lib/stretchy/attributes/type/rank_features.rb

@@ -1,19 +1,26 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a rank_features attribute for the model.
+  # The RankFeatures attribute type
   #
-  # A rank_features field can index numeric feature vectors, so that they can later be used to boost documents in queries with a rank_feature query.
-
-  # It is analogous to the rank_feature data type but is better suited when the list of features is sparse so that it wouldn’t be reasonable to add one field to the mappings for each of them.
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :positive_score_impact - The Boolean indicating if features correlate positively with the score. If set to false, the score decreases with the value of the feature instead of increasing. Defaults to true.
+  # This class is used to define a rank_features attribute for a model. It provides support for the Elasticsearch rank_features data type, which is a type of data type that can index numeric feature vectors, so that they can later be used to boost documents in queries with a rank_feature query. It is better suited when the list of features is sparse so that it wouldn’t be reasonable to add one field to the mappings for each of them.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:rank_features`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:positive_score_impact:` The Boolean indicating if features correlate positively with the score. If set to false, the score decreases with the value of the feature instead of increasing. Defaults to true.
+  #
+  # ---
+  #
+  # ### Examples
   #
-  # Examples
+  # #### Define a rank_features attribute
   #
-  #   class MyModel < Stretchy::Record
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :negative_reviews, :rank_features, positive_score_impact: false
   #   end
+  # ```
   #
-  # Returns nothing.
   class RankFeatures < Stretchy::Attributes::Type::Hash
     OPTIONS = [:positive_score_impact]
 

data/lib/stretchy/attributes/type/search_as_you_type.rb

@@ -1,25 +1,35 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a search_as_you_type attribute for the model. This field type is optimized to provide out-of-the-box support for queries that serve an as-you-type completion use case.
-  #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :max_shingle_size - The Integer indicating the largest shingle size to create. Valid values are 2 to 4. Defaults to 3.
-  #        :analyzer - The String analyzer to be used for text fields, both at index-time and at search-time. Defaults to the default index analyzer, or the standard analyzer.
-  #        :index - The Boolean indicating if the field should be searchable. Defaults to true.
-  #        :index_options - The String indicating what information should be stored in the index, for search and highlighting purposes. Defaults to 'positions'.
-  #        :norms - The Boolean indicating if field-length should be taken into account when scoring queries. Defaults to true.
-  #        :store - The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
-  #        :search_analyzer - The String analyzer that should be used at search time on text fields. Defaults to the analyzer setting.
-  #        :search_quote_analyzer - The String analyzer that should be used at search time when a phrase is encountered. Defaults to the search_analyzer setting.
-  #        :similarity - The String indicating which scoring algorithm or similarity should be used. Defaults to 'BM25'.
-  #        :term_vector - The String indicating if term vectors should be stored for the field. Defaults to 'no'.
-  #
-  # Examples
-  #
-  #   class MyModel < Stretchy::Record
+  # The SearchAsYouType attribute type
+  #
+  # This class is used to define a search_as_you_type attribute for a model. This field type is optimized to provide out-of-the-box support for queries that serve an as-you-type completion use case.
+  #
+  # ### Parameters
+  #
+  # - `type:` `:search_as_you_type`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:max_shingle_size:` The Integer indicating the largest shingle size to create. Valid values are 2 to 4. Defaults to 3.
+  #    - `:analyzer:` The String analyzer to be used for text fields, both at index-time and at search-time. Defaults to the default index analyzer, or the standard analyzer.
+  #    - `:index:` The Boolean indicating if the field should be searchable. Defaults to true.
+  #    - `:index_options:` The String indicating what information should be stored in the index, for search and highlighting purposes. Defaults to 'positions'.
+  #    - `:norms:` The Boolean indicating if field-length should be taken into account when scoring queries. Defaults to true.
+  #    - `:store:` The Boolean indicating if the field value should be stored and retrievable separately from the _source field. Defaults to false.
+  #    - `:search_analyzer:` The String analyzer that should be used at search time on text fields. Defaults to the analyzer setting.
+  #    - `:search_quote_analyzer:` The String analyzer that should be used at search time when a phrase is encountered. Defaults to the search_analyzer setting.
+  #    - `:similarity:` The String indicating which scoring algorithm or similarity should be used. Defaults to 'BM25'.
+  #    - `:term_vector:` The String indicating if term vectors should be stored for the field. Defaults to 'no'.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a search_as_you_type attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :name, :search_as_you_type, max_shingle_size: 4
   #   end
+  # ```
   #
-  # Returns nothing.
   class SearchAsYouType < Stretchy::Attributes::Type::Base
     OPTIONS = [:max_shingle_size, :analyzer, :index, :index_options, :norms, :store, :search_analyzer, :search_quote_analyzer, :similarity, :term_vector]
 

data/lib/stretchy/attributes/type/shape.rb

@@ -1,19 +1,29 @@
 module Stretchy::Attributes::Type
-  # Public: Defines a shape attribute for the model. This field type is used for complex shapes.
+  # The Shape attribute type
   #
-  # opts - The Hash options used to refine the attribute (default: {}):
-  #        :orientation - The String indicating how to interpret vertex order for polygons / multipolygons. Can be 'right', 'ccw', 'counterclockwise', 'left', 'cw', 'clockwise'. Defaults to 'ccw'.
-  #        :ignore_malformed - The Boolean indicating if malformed GeoJSON or WKT shapes should be ignored. Defaults to false.
-  #        :ignore_z_value - The Boolean indicating if the z value of three dimension points should be ignored. Defaults to true.
-  #        :coerce - The Boolean indicating if unclosed linear rings in polygons will be automatically closed. Defaults to false.
+  # This class is used to define a shape attribute for a model. It provides support for the Elasticsearch shape data type, which is a type of data type that can hold complex shapes represented as GeoJSON or WKT.
   #
-  # Examples
+  # ### Parameters
   #
-  #   class MyModel < Stretchy::Record
+  # - `type:` `:shape`.
+  # - `options:` The Hash of options for the attribute.
+  #    - `:orientation:` The String indicating how to interpret vertex order for polygons / multipolygons. Can be 'right', 'ccw', 'counterclockwise', 'left', 'cw', 'clockwise'. Defaults to 'ccw'.
+  #    - `:ignore_malformed:` The Boolean indicating if malformed GeoJSON or WKT shapes should be ignored. Defaults to false.
+  #    - `:ignore_z_value:` The Boolean indicating if the z value of three dimension points should be ignored. Defaults to true.
+  #    - `:coerce:` The Boolean indicating if unclosed linear rings in polygons will be automatically closed. Defaults to false.
+  #
+  # ---
+  #
+  # ### Examples
+  #
+  # #### Define a shape attribute
+  #
+  # ```ruby
+  #   class MyModel < StretchyModel
   #     attribute :boundary, :shape, orientation: 'cw'
   #   end
+  # ```
   #
-  # Returns nothing.
   class Shape < Stretchy::Attributes::Type::Base
     OPTIONS = [:orientation, :ignore_malformed, :ignore_z_value, :coerce]