Make docstring of gen(::FqField) less ambiguous (#1522)

Nemocas · Aug 15, 2023 · 2dba7d8 · 2dba7d8
1 parent 38fd074
commit 2dba7d8
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/src/flint/fq_default_extended.jl b/src/flint/fq_default_extended.jl
@@ -146,11 +146,13 @@ end
 ################################################################################
 
 @doc raw"""
-    gen(a::FqField)
+    gen(L::FqField)
 
-Return the algebra generator of the finite field over its base field.
+Return a $K$-algebra generator `a` of the finite field $L$, where $K$ is the
+base field of $L$. The element `a` satisfies `defining_polyomial(a) == 0`.
 
-Note that this is in general not a multiplicative generator.
+Note that this is in general not a multiplicative generator and can be zero, if
+$L/K$ is an extension of degree one.
 """
 function gen(L::FqField)
   # should not be cached (for in place stuff etc)