From ba3d3d3c295a9fc23bc8b56c7f7ef0b5781d9e4d Mon Sep 17 00:00:00 2001 From: mhostetter Date: Wed, 16 Nov 2022 14:58:46 -0500 Subject: [PATCH] Minor clarifications in docs --- docs/basic-usage/element-representation.rst | 2 +- src/galois/_fields/_array.py | 5 +++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/basic-usage/element-representation.rst b/docs/basic-usage/element-representation.rst index 65c8e9ec4..49759f5c1 100644 --- a/docs/basic-usage/element-representation.rst +++ b/docs/basic-usage/element-representation.rst @@ -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 diff --git a/src/galois/_fields/_array.py b/src/galois/_fields/_array.py index 9b37db59a..80148687a 100644 --- a/src/galois/_fields/_array.py +++ b/src/galois/_fields/_array.py @@ -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 ----------