Skip to content

Commit

Permalink
Minor clarifications in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mhostetter committed Nov 17, 2022
1 parent 6ae4a78 commit ba3d3d3
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/basic-usage/element-representation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ The element representation can be temporarily changed using the :func:`~galois.F
# Outside the context manager, x prints using the previous representation
print(x)
The element representation can be permanently changed using the :func:`~galois.FieldArray.repr` method.
The element representation can be permanently changed using the :func:`~galois.FieldArray.repr` classmethod (not as a context manager).

.. ipython:: python
Expand Down
5 changes: 3 additions & 2 deletions src/galois/_fields/_array.py
Original file line number Diff line number Diff line change
Expand Up @@ -1502,10 +1502,11 @@ def log(self, base: ElementLike | ArrayLike | None = None) -> int | np.ndarray:
r"""
Computes the logarithm of the array :math:`x` base :math:`\beta`.
.. warning::
.. danger::
If the Galois field is configured to use lookup tables, `ufunc_mode == "jit-lookup"`, and this function is invoked
with a base different from :obj:`~FieldArray.primitive_element`, then explicit calculation will be used.
with a base different from :obj:`~FieldArray.primitive_element`, then explicit calculation will be used (which is
slower than lookup tables).
Parameters
----------
Expand Down

0 comments on commit ba3d3d3

Please sign in to comment.