Skip to content

Commit fccbc06

Browse files
committed
add explicit reexport
1 parent b9d0883 commit fccbc06

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

src/arraytex/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,6 @@
22

33
from .api import to_matrix
44
from .api import to_tabular
5+
6+
7+
__all__ = ["to_matrix", "to_tabular"]

src/arraytex/api.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,13 @@ def to_matrix(
2727
arr: the array to be converted
2828
style: a style formatter string, either "b" for "bmatrix" or "p" for "pmatrix"
2929
num_format: a number formatter string, e.g. ".2f"
30-
scientific_notation: a flag to determine whether 1 x 10^3 should be used,
31-
otherwise e-notation is used (1e3)
30+
scientific_notation: a flag to determine whether e.g. 1 x 10^3 format should
31+
be used if ".e" is used for `num_format`, otherwise e-notation (1e3)
32+
is used
3233
to_clp: copy the output to the system clipboard
3334
3435
Returns:
35-
the string representation of the array
36+
the LaTeX matrix string representation of the array
3637
3738
Raises:
3839
TooManyDimensionsError: when the supplied array has more than 2 dimensions
@@ -75,7 +76,7 @@ def to_tabular(
7576
to_clp: copy the output to the system clipboard
7677
7778
Returns:
78-
the string representation of the array
79+
the LaTeX tabular string representation of the array
7980
8081
Raises:
8182
TooManyDimensionsError: when the supplied array has more than 2 dimensions

0 commit comments

Comments
 (0)