lib/unit_measurements/base.rb in unit_measurements-5.11.0 vs lib/unit_measurements/base.rb in unit_measurements-5.11.1

@@ -3,10 +3,28 @@
 # -*- warn_indent: true -*-
 
 require "active_support/all"
 require "unit_measurements/version"
 
+# The +UnitMeasurements+ module serves as a container for various functionalities
+# related to unit measurements. It provides methods for creating custom unit
+# groups, defining units, performing arithmetic operations,  comparison between
+# measurements, conversions, normalization of input strings, parsing measurements
+# from strings, and more. It is a fundamental part of the unit measurements library.
+#
+# @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+# @since 0.1.0
 module UnitMeasurements
+  # This is the base class for custom errors in the +UnitMeasurements+ module.
+  #
+  # @see ParseError
+  # @see PrimitiveUnitAlreadySetError
+  # @see UnitAlreadyDefinedError
+  # @see UnitError
+  # @author {Harshal V. Ladhe}[https://shivam091.github.io/]
+  # @since 1.1.0
+  class BaseError < StandardError; end
+
   class << self
     # Allows setting an instance of +Configuration+ containing values of desired
     # configurable options.
     #
     # @author {Harshal V. Ladhe}[https://shivam091.github.io/]