Inaccurate documentation for number field elements_of_norm

[JohnCremona]

For a number field K and an integer n,
the function K.elements_of_norm(n) returns
a list of integral elements of K with norm n,
up to multiplication by units of positive norm.
The docstring says that n should be an "integer
in this number field", which is wrong (and makes
no sense): it must be a rational integer.

If you give the function something else (e.g. a
non-integral rational or an element of K (even
K(0)), a PariError is raised, and it would be
better for Sage to check the input, say by trying
n = ZZ(n) first.

CC: @slel

Component: number fields

Keywords: number field norm

Author: Frédéric Chapoton

Branch/Commit: 59e2efa

Reviewer: John Cremona

Issue created by migration from https://trac.sagemath.org/ticket/32860

[fchapoton]

Author: Frédéric Chapoton

[fchapoton]

New commits:

59e2efa

fix doc for elements_of_norm

[fchapoton]

Commit: 59e2efa

[fchapoton]

Branch: u/chapoton/32860

[fchapoton]

comment:3

here is a minimal branch

[JohnCremona]

comment:4

Thanks. I report things and then simply forget.

I'm not familiar with the syntax --> list in the function header. Is that a new python thing?

[fchapoton]

comment:5

This is a "type annotation". This means that it is a declaration stating that the output is a list.

This kind of annotation (optional) has been introduced in recent versions of python. It allows some tools (mypy) to check consistency inside the code. Also useful for refined tab completions, in principle.

The lights are green, so the branch is ready for review.

[JohnCremona]

Reviewer: John Cremona

[vbraun]

Changed branch from u/chapoton/32860 to 59e2efa