Add missing doc to enum init

Author: Mauko Quiroga

openfisca_core/indexed_enums/enum.py

@@ -65,6 +65,21 @@ def __init__(self, name: str) -> None:
         names of the previously initialized items, so its length is the index
         of this item.
 
+        Args:
+            name: The name of the enum.
+
+        Examples:
+            >>> MyEnum = Enum("MyEnum", "foo bar")
+            >>> MyEnum.bar.index
+            1
+
+            >>> class MyEnum(Enum):
+            ...     foo = b"foo"
+            ...     bar = b"bar"
+
+            >>> MyEnum.bar.index
+            1
+
         """
 
         self.index = len(self._member_names_)

openfisca_core/indexed_enums/enum_array.py

@@ -76,6 +76,9 @@ def __eq__(self, other: Any) -> Union[ArrayType[bool], bool]:
         Args:
             other: Another object to compare to.
 
+        Returns:
+            True, False, or a boolean :class:`numpy.ndarray`.
+
         Examples:
             >>> class MyEnum(enums.Enum):
             ...     foo = b"foo"
@@ -112,6 +115,9 @@ def __ne__(self, other: Any) -> Union[ArrayType[bool], bool]:
         Args:
             other: Another object to compare to.
 
+        Returns:
+            True, False, or a boolean :class:`numpy.ndarray`.
+
         Examples:
             >>> class MyEnum(enums.Enum):
             ...     foo = b"foo"
@@ -155,7 +161,10 @@ def _forbidden_operation(self, other: Any) -> NoReturn:
     __or__ = _forbidden_operation
 
     def decode(self) -> ArrayType["enums.Enum"]:
-        """Return the enum items of the :obj:`.EnumArray`.
+        """Decodes itself to a normal array.
+
+        Returns:
+            The enum items of the :obj:`.EnumArray`.
 
         Examples:
             >>> class MyEnum(enums.Enum):
@@ -175,7 +184,10 @@ def decode(self) -> ArrayType["enums.Enum"]:
             )
 
     def decode_to_str(self) -> ArrayType[str]:
-        """Return the string identifiers of the :obj:`.EnumArray`.
+        """Decodes itself to an array of strings.
+
+        Returns:
+            The string identifiers of the :obj:`.EnumArray`.
 
         Examples:
             >>> class MyEnum(enums.Enum):