#9976: Decorated functions/methods have generic signature in documentation
--------------------------------+-------------------------------------------
   Reporter:  jsrn              |       Owner:  jsrn                            
        
       Type:  enhancement       |      Status:  needs_review                    
        
   Priority:  major             |   Milestone:  sage-4.7                        
        
  Component:  documentation     |    Keywords:  sphinx, documentation, cython 
inspection
     Author:  jsrn, Simon King  |    Upstream:  N/A                             
        
   Reviewer:  Simon King        |      Merged:                                  
        
Work_issues:                    |  
--------------------------------+-------------------------------------------
Changes (by SimonKing):

  * status:  needs_work => needs_review


Comment:

 I updated the inspection_of_cython.patch: In the relevant functions, I
 made a special case for instances of functools.partial.

 By consequence, building the doc for sage.combinat.partition_algebra
 showed a couple of warnings, that were caused by syntax errors in the doc
 string (amazing, how often that occurs in sage/combinat...). It is fixed
 by an update of my doc_fixes.patch, so that its documentation builds
 without error, but includes the previously missing items.

 The price to pay: Several items have the same documentation. I am willing
 to pay that price, for the alternative is to not have these docs in the
 references at all.

 Apply trac_9976_decorated_generic_sigs_alternative.patch
 9976-inspection_of_cython.patch 9976_doc_fixes.patch
 9976_notebook_doc_fixes.patch

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9976#comment:149>
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 post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/sage-trac?hl=en.

Reply via email to