diff --git a/openfisca_core/indexed_enums/enum.py b/openfisca_core/indexed_enums/enum.py index ed19b96807..0dba667251 100644 --- a/openfisca_core/indexed_enums/enum.py +++ b/openfisca_core/indexed_enums/enum.py @@ -93,13 +93,14 @@ def __init__(self, name: str) -> None: @classmethod def encode(cls, array: Encodable) -> EnumArray: - """Encodes an :class:`.Encodable` array into an :class:`.EnumArray.` + """Encodes an encodable array into an :obj:`.EnumArray`. Args: array: Array to encode. Returns: - An array with the encoded input values. + :obj:`.EnumArray`: An :obj:`array <.EnumArray>` with the encoded + input values. Examples: >>> class MyEnum(Enum): @@ -113,28 +114,28 @@ def encode(cls, array: Encodable) -> EnumArray: >>> MyEnum.encode(enum_array) EnumArray([]) - # ArrayLike["Enum"] + # ArrayTipe[Enum] >>> array = numpy.array([MyEnum.bar]) >>> enum_array = MyEnum.encode(array) >>> enum_array[0] == MyEnum.bar.index True - # ArrayLike[bytes] + # ArrayType[bytes] >>> array = numpy.array([b"bar"]) >>> enum_array = MyEnum.encode(array) >>> enum_array[0] == MyEnum.bar.index True - # ArrayLike[int] + # ArrayType[int] >>> array = numpy.array([1]) >>> enum_array = MyEnum.encode(array) >>> enum_array[0] == MyEnum.bar.index True - # ArrayLike[str] + # ArrayType[str] >>> array = numpy.array(["bar"]) >>> enum_array = MyEnum.encode(array) diff --git a/openfisca_core/indexed_enums/enum_array.py b/openfisca_core/indexed_enums/enum_array.py index 7ea23a8ecb..4109db10f3 100644 --- a/openfisca_core/indexed_enums/enum_array.py +++ b/openfisca_core/indexed_enums/enum_array.py @@ -15,7 +15,7 @@ class EnumArray(numpy.ndarray): Note: Subclassing `numpy.ndarray` is a little tricky™. To read more about the - :meth:`.__new__` and `.__array_finalize__` methods below, see + :meth:`.__new__` and :meth:`.__array_finalize__` methods below, see `Subclassing ndarray`_. Examples: