Skip to content

Commit

Permalink
Make files distinct by adding docstrings.
Browse files Browse the repository at this point in the history
  • Loading branch information
jpivarski committed Dec 27, 2023
1 parent acc6d63 commit 23cc578
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 7 deletions.
13 changes: 9 additions & 4 deletions src/ragged/__init__.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# BSD 3-Clause License; see https://github.com/scikit-hep/ragged/blob/main/LICENSE

from __future__ import annotations
"""
Ragged array module.
FIXME: needs more documentation!
from ._version import version as __version__
from .v202212 import array
Version 2022.12 is current, so `ragged.v202212.*` is identical to `ragged.*`.
"""

from __future__ import annotations

__all__ = ["array", "__version__"]
from .v202212 import * # noqa: F403
7 changes: 7 additions & 0 deletions src/ragged/common/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# BSD 3-Clause License; see https://github.com/scikit-hep/ragged/blob/main/LICENSE

"""
Generic definitions used by the version-specific modules, such as
`ragged.v202212`.
https://data-apis.org/array-api/latest/API_specification/
"""

from __future__ import annotations

from ._obj import array
Expand Down
3 changes: 0 additions & 3 deletions src/ragged/common/_obj.py
Original file line number Diff line number Diff line change
Expand Up @@ -877,6 +877,3 @@ def __irshift__(self, other: int | array, /) -> array:
__rxor__ = __xor__
__rlshift__ = __lshift__
__rrshift__ = __rshift__


__all__ = ["array"]
9 changes: 9 additions & 0 deletions src/ragged/v202212/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# BSD 3-Clause License; see https://github.com/scikit-hep/ragged/blob/main/LICENSE

"""
Defines a ragged array module that is compliant with version 2022.12 of the
Array API.
This is the current default: `ragged.v202212.*` is imported into `ragged.*`.
https://data-apis.org/array-api/2022.12/API_specification/
"""

from __future__ import annotations

from ._obj import array
Expand Down

0 comments on commit 23cc578

Please sign in to comment.