Skip to content

Commit

Permalink
Make docstring of gen(::FqField) less ambiguous
Browse files Browse the repository at this point in the history
  • Loading branch information
thofma committed Aug 15, 2023
1 parent 38fd074 commit dde7eee
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/flint/fq_default_extended.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit dde7eee

Please sign in to comment.