Ticket #8335: trac_8335-doc-5.7.beta3.patch

File trac_8335-doc-5.7.beta3.patch, 4.5 KB (added by jpflori, 9 years ago)

Patch for doc fixes; rebased on top of 5.7.beta3.

  • sage/rings/finite_rings/constructor.py

    # HG changeset patch
    # User Jean-Pierre Flori <jean-pierre.flor@ssi.gouv.fr>
    # Date 1360334827 -3600
    # Node ID 82e5ecd6aad3ade29bcce72b58da56652f8619a9
    # Parent  5aeb85284566ba65f1fb28f2ad6c6d01501658a6
    #8335: Doc fixes
    
    diff --git a/sage/rings/finite_rings/constructor.py b/sage/rings/finite_rings/constructor.py
    a b  
    66Sage for several sizes of primes `p`. These implementations
    77are
    88
    9 
    109-  ``sage.rings.finite_rings.integer_mod.IntegerMod_int``,
    1110
    1211-  ``sage.rings.finite_rings.integer_mod.IntegerMod_int64``, and
     
    179178    Return the globally unique finite field of given order with
    180179    generator labeled by the given name and possibly with given
    181180    modulus.
    182    
     181
    183182    INPUT:
    184    
    185    
    186     -  ``order`` - int
    187    
    188     -  ``name`` - string; must be specified unless
    189        - ``order`` is prime
    190        - ``modulus`` is 'conway', in which case a name is generated
     183
     184    - ``order`` - int
     185
     186    - ``name`` - string; must be specified unless
     187
     188        - ``order`` is prime
     189
     190        - ``modulus`` is 'conway', in which case a name is generated
    191191          from the degree and the ``prefix`` string.
    192    
    193     -  ``modulus`` - (optional) either a defining polynomial for the
    194        field, i.e., generator of the field will be a root of this
    195        polynomial; or a string:
    196192
    197            - 'conway': force the use of a pseudo-Conway polynomial.
    198             If a conway polynomial is found in the database, that is used.
    199             Otherwise, a polynomial is used with the same algebraic properties
    200             but without the lexicographic constraint implying uniqueness.
    201            - 'random': use a random irreducible polynomial;
    202            - 'default': a Conway polynomial is used if in the database. Otherwise
    203             a sparse polynomial is used for binary fields and a
    204             random polynomial is used for other characteristics.
    205            - 'first_lexicographic': uses the first irreducible polynomial.
     193    - ``modulus`` - (optional) either a defining polynomial for the
     194      field, i.e., generator of the field will be a root of this
     195      polynomial; or a string:
    206196
    207        Other options might be available depending on the
    208        implementation.
    209    
    210     -  ``elem_cache`` - cache all elements to avoid
    211        creation time (default: order < 500)
    212    
    213     -  ``check_irreducible`` - verify that the polynomial
    214        modulus is irreducible
     197        - 'conway': force the use of a pseudo-Conway polynomial.
     198          If a conway polynomial is found in the database, that is used.
     199          Otherwise, a polynomial is used with the same algebraic properties
     200          but without the lexicographic constraint implying uniqueness.
     201
     202        - 'random': use a random irreducible polynomial;
     203
     204        - 'default': a Conway polynomial is used if in the database. Otherwise
     205          a sparse polynomial is used for binary fields and a
     206          random polynomial is used for other characteristics.
     207
     208        - 'first_lexicographic': uses the first irreducible polynomial.
     209
     210        - Other options might be available depending on the implementation.
     211
     212    - ``elem_cache`` - cache all elements to avoid
     213      creation time (default: order < 500)
     214
     215    - ``check_irreducible`` - verify that the polynomial
     216      modulus is irreducible
    215217
    216218    - ``prefix`` (default: 'z') - a string used to generate names
    217219      for subfields and pushouts of this field (mainly for use with
     
    219221
    220222    - ``proof`` -- bool (default: True); if True use provable
    221223      primality test; otherwise only use pseudoprimality test.
    222    
    223     -  ``args`` - additional parameters passed to finite
    224        field implementations
    225    
    226     -  ``kwds`` - additional keyword parameters passed to
    227        finite field implementations
    228    
    229    
     224
     225    - ``args`` - additional parameters passed to finite
     226      field implementations
     227
     228    - ``kwds`` - additional keyword parameters passed to
     229      finite field implementations
     230
    230231    ALIAS: You can also use GF instead of FiniteField - they are
    231232    identical.
    232233
    233234    EXAMPLES::
    234    
     235
    235236        sage: k.<a> = FiniteField(9); k
    236237        Finite Field in a of size 3^2
    237238        sage: parent(a)
     
    339340        True
    340341   
    341342    You may print finite field elements as integers. This
    342     currently only works if the order of field is `<2^{16}`,
     343    currently only works if the order of field is `< 2^{16}`,
    343344    though.
    344345   
    345346    ::