Ticket #12767: trac_12767_INPUT.patch

File trac_12767_INPUT.patch, 980 bytes (added by benjaminfjones, 9 years ago)

document INPUT for maximal_order

  • sage/rings/number_field/number_field_rel.py

    # HG changeset patch
    # User Benjamin Jones <benjaminfjones@gmail.com>
    # Date 1337999655 25200
    # Node ID 69b060f83b51ed91445246b6c138e27418b21b69
    # Parent  4766bf776b48969396ee11d80811adef6a492896
    Trac 12767: document INPUT in `maximal_order`
    
    diff --git a/sage/rings/number_field/number_field_rel.py b/sage/rings/number_field/number_field_rel.py
    a b  
    614614        Return the maximal order, i.e., the ring of integers of this
    615615        number field.
    616616
     617        INPUT:
     618
     619        -  ``v`` - (default: None) None, a prime, or a list of
     620           primes.
     621
     622           - if v is None, return the maximal order.
     623
     624           - if v is a prime, return an order that is p-maximal.
     625
     626           - if v is a list, return an order that is maximal at each
     627             prime in the list v.
     628
    617629        EXAMPLES::
    618630
    619631            sage: K.<a,b> = NumberField([x^2 + 1, x^2 - 3])