Ticket #1902 (closed defect: fixed)

Opened 5 years ago

Last modified 5 years ago

[with patch, positive review] mistake in the documentation for gens for Finite field givaro

Reported by: was Owned by: cremona
Priority: major Milestone: sage-2.10.3
Component: basic arithmetic Keywords:
Cc: Work issues:
Report Upstream: Reviewers:
Authors: Merged in:
Dependencies: Stopgaps:

Description 

> sage: sage.rings.finite_field_givaro.FiniteField_givaro.gen?
> [...]
> Docstring:
> 
>             Return a generator of self. All elements x of self are
>             expressed as log_{self.gen()}(p) internally. If self is
>             a prime field this method returns 1.
> 
> (The sentence "If self is a prime field..." is wrong, but the first
> sentence is correct.)

Attachments

8683.patch Download (1.3 KB) - added by cremona 5 years ago.
edited-8683.patch Download (1.3 KB) - added by cwitty 5 years ago.

Change History

Changed 5 years ago by cremona

comment:1 Changed 5 years ago by cremona

  • Owner changed from somebody to cremona
  • Status changed from new to assigned
  • Summary changed from mistake in the documentation for gens for Finite field givaro to [with patch, needs review] mistake in the documentation for gens for Finite field givaro

Attached patch corrects the docstring and adds a new doctest which is relevant,

Changed 5 years ago by cwitty

comment:2 Changed 5 years ago by cwitty

  • Summary changed from [with patch, needs review] mistake in the documentation for gens for Finite field givaro to [with patch, positive review] mistake in the documentation for gens for Finite field givaro

I hand-edited John's original 8683.patch to create edited-8683.patch: I changed "primitve" -> "primitive".

With this revised patch: looks good, the doctest passes.

comment:3 Changed 5 years ago by mabshoff

  • Status changed from assigned to closed
  • Resolution set to fixed

Merged edited-8683.patch in Sage 2.10.3.rc1

Note: See TracTickets for help on using tickets.