Changes between Version 125 and Version 152 of Ticket #11115


Ignore:
Timestamp:
10/25/11 09:45:34 (2 years ago)
Author:
SimonKing
Comment:

Hooray! With the blank line, the missing first lines of the modp_splitting_data doc string (and other instances) re-appear, and most importantly the error has vanished:

king@mpc622:/mnt/local/king/SAGE/rebase/sage-4.7.2.alpha4$ grep -i error dochtml.log
reading sources... [ 79%] sage/rings/padics/precision_error
writing output... [ 79%] sage/rings/padics/precision_error

The new patch does the following:

  • Fix some wrong docstring formats that I stumbled over.
  • Add the required blank line after the embedding information in the doc strings of cached methods.
  • In two cases, a cached function has been created by first defining a non-cached function, e.g. adem_, and then defining adem = CachedFunction(adem_). If I am not mistaken, both functions would be included in the docs, which is not good. So, for aesthetic reasons, I rewrote it using @cached_function.

I am now running doc tests. It could be that some tests in sage_inspect will fail. But I am confident enough to turn it into "needs review".

For the patch bot:

Apply trac11115-cached_cython.patch trac11115_element_with_cache.patch trac11115_cached_function_pickling.patch trac_11115_reviewer.patch trac_11115_docfix.patch

Legend:

Unmodified
Added
Removed
Modified
  • Ticket #11115

    • Property Status changed from positive_review to needs_review
    • Property Work issues changed from to docbuild
  • Ticket #11115 – Description

    v125 v152  
    4343 1. [attachment:trac11115_cached_function_pickling.patch] 
    4444 1. [attachment:trac_11115_reviewer.patch] 
     45 1. [attachment:trac_11115_docfix.patch] 
    4546 
    4647Note that, if you want to '''remove''' the patches after testing them, you need to do