#17847: Cython: embed signatures in docstrings
-------------------------------+------------------------
       Reporter:  jdemeyer     |        Owner:
           Type:  enhancement  |       Status:  new
       Priority:  major        |    Milestone:  sage-6.6
      Component:  cython       |   Resolution:
       Keywords:               |    Merged in:
        Authors:               |    Reviewers:
Report Upstream:  N/A          |  Work issues:
         Branch:               |       Commit:
   Dependencies:               |     Stopgaps:
-------------------------------+------------------------
Description changed by jdemeyer:

Old description:



New description:

 Before:
 {{{
 sage: print GF(5).factored_unit_order.__doc__
 File: sage/rings/finite_rings/finite_field_base.pyx (starting at line 729)

         Returns the factorization of ``self.order()-1``, as a 1-element
 list.

         The format is for compatibility with
         :mod:`~sage.rings.finite_rings.integer_mod_ring`.

         EXAMPLES::

             sage: GF(7^2,'a').factored_unit_order()
             [2^4 * 3]

 }}}

 After:
 {{{
 sage: print GF(5).factored_unit_order.__doc__
 FiniteField.factored_unit_order(self)
 File: sage/rings/finite_rings/finite_field_base.pyx (starting at line 729)

         Returns the factorization of ``self.order()-1``, as a 1-element
 list.

         The format is for compatibility with
         :mod:`~sage.rings.finite_rings.integer_mod_ring`.

         EXAMPLES::

             sage: GF(7^2,'a').factored_unit_order()
             [2^4 * 3]

 }}}

--

--
Ticket URL: <http://trac.sagemath.org/ticket/17847#comment:1>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica, 
and MATLAB

-- 
You received this message because you are subscribed to the Google Groups 
"sage-trac" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/sage-trac.
For more options, visit https://groups.google.com/d/optout.

Reply via email to