#17847: Cython: embed signatures in docstrings of Sage library code
-------------------------------------+-------------------------------------
       Reporter:  jdemeyer           |        Owner:
           Type:  enhancement        |       Status:  new
       Priority:  major              |    Milestone:  sage-6.6
      Component:  cython             |   Resolution:
       Keywords:                     |    Merged in:
        Authors:  Jeroen Demeyer,    |    Reviewers:  Simon King
  Simon King                         |  Work issues:
Report Upstream:  Fixed upstream,    |       Commit:
  but not in a stable release.       |  19135c15db9122693b8d8d023fe59749eb1a1d64
         Branch:                     |     Stopgaps:
  u/SimonKing/ticket/17847           |
   Dependencies:                     |
-------------------------------------+-------------------------------------

Comment (by SimonKing):

 Replying to [comment:64 jdemeyer]:
 > Why should the cached function change ''anything'' to the doc? I think
 it should just pass through the original documentation unchanged.

 For the same reason that Cython inserts additional information to the doc.
 It helps to retrieve file information. As you have observed, we have no
 `_sage_getfile_` method. We would need to have such method, if we would
 not insert the embedding information of the ''original function'' into the
 doc of the ''cached function''.

--
Ticket URL: <http://trac.sagemath.org/ticket/17847#comment:66>
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