#5734: [with patch, needs review] Bring doctests of
modular/modsym/manin_symbols.py up to 100%
---------------------+------------------------------------------------------
 Reporter:  cremona  |       Owner:  mabshoff       
     Type:  defect   |      Status:  new            
 Priority:  major    |   Milestone:  sage-3.4.2     
Component:  doctest  |    Keywords:  modular symbols
---------------------+------------------------------------------------------

Old description:

> As of 3.4.1.rc1, we have
> {{{
> SCORE /home/jec/sage-3.4.1.rc1/devel/sage-
> main/sage/modular/modsym/manin_symbols.py: 2% (2 of 68)
>
> Missing documentation:
>          * is_ManinSymbol(x):
>          * __init__(self, weight, list):
>          * __cmp__(self, right):
>          * __getitem__(self, n):
>          * __len__(self):
>          * apply(self, j, X):
>          * apply_S(self, j):
>          * apply_I(self, j):
>          * apply_T(self, j):
>          * apply_TT(self, j):
>          * manin_symbol_list(self):
>          * manin_symbol(self, i):
>          * normalize(self, x):
>          * weight(self):
>          * __init__(self, level, weight, syms):
>          * apply_T(self, j):
>          * apply_TT(self, j):
>          * level(self):
>          * normalize(self, x):
>          * __init__(self, level, weight):
>          * __repr__(self):
>          * __init__(self, level, weight):
>          * __repr__(self):
>          * __init__(self, group, weight):
>          * __repr__(self):
>          * __init__(self, character, weight):
>          * __repr__(self):
>          * apply_T(self, j):
>          * apply_TT(self, j):
>          * character(self):
>          * level(self):
>          * normalize(self, x):
>          * __init__(self, level, weight):
>          * __repr__(self):
>          * apply_T(self, j):
>          * apply_TT(self, j):
>          * level(self):
>          * normalize(self, x):
>          * tuple(self):
>          * __get_i(self):
>          * __get_u(self):
>          * __get_v(self):
>          * _repr_(self):
>          * _latex_(self):
>          * __cmp__(self, other):
>          * __mul__(self, matrix):
>          * copy(self):
>          * parent(self):
>          * weight(self):
>          * _print_polypart(i, j):
>

> Missing doctests:
>          * index(self, x):
>          * apply_S(self, j):
>          * apply_I(self, j):
>          * apply(self, j, m):
>          * apply_S(self, j):
>          * apply_I(self, j):
>          * index(self, x):
>          * apply_S(self, j):
>          * apply_I(self, j):
>          * apply_J(self, j):
>          * apply(self, j, m):
>          * __init__(self, parent, t):
>          * apply(self, a,b,c,d):
>          * lift_to_sl2z(self, N):
>          * endpoints(self, N=None):
>          * modular_symbol_rep(self):
> }}}
> and I think I might have the right background to fix this!

New description:

 As of 3.4.1.rc1, we have
 {{{
 SCORE /home/jec/sage-3.4.1.rc1/devel/sage-
 main/sage/modular/modsym/manin_symbols.py: 2% (2 of 68)

 Missing documentation:
          * is_ManinSymbol(x):
          * __init__(self, weight, list):
          * __cmp__(self, right):
          * __getitem__(self, n):
          * __len__(self):
          * apply(self, j, X):
          * apply_S(self, j):
          * apply_I(self, j):
          * apply_T(self, j):
          * apply_TT(self, j):
          * manin_symbol_list(self):
          * manin_symbol(self, i):
          * normalize(self, x):
          * weight(self):
          * __init__(self, level, weight, syms):
          * apply_T(self, j):
          * apply_TT(self, j):
          * level(self):
          * normalize(self, x):
          * __init__(self, level, weight):
          * __repr__(self):
          * __init__(self, level, weight):
          * __repr__(self):
          * __init__(self, group, weight):
          * __repr__(self):
          * __init__(self, character, weight):
          * __repr__(self):
          * apply_T(self, j):
          * apply_TT(self, j):
          * character(self):
          * level(self):
          * normalize(self, x):
          * __init__(self, level, weight):
          * __repr__(self):
          * apply_T(self, j):
          * apply_TT(self, j):
          * level(self):
          * normalize(self, x):
          * tuple(self):
          * __get_i(self):
          * __get_u(self):
          * __get_v(self):
          * _repr_(self):
          * _latex_(self):
          * __cmp__(self, other):
          * __mul__(self, matrix):
          * copy(self):
          * parent(self):
          * weight(self):
          * _print_polypart(i, j):


 Missing doctests:
          * index(self, x):
          * apply_S(self, j):
          * apply_I(self, j):
          * apply(self, j, m):
          * apply_S(self, j):
          * apply_I(self, j):
          * index(self, x):
          * apply_S(self, j):
          * apply_I(self, j):
          * apply_J(self, j):
          * apply(self, j, m):
          * __init__(self, parent, t):
          * apply(self, a,b,c,d):
          * lift_to_sl2z(self, N):
          * endpoints(self, N=None):
          * modular_symbol_rep(self):
 }}}
 and I think I might have the right background to fix this!

--

Comment(by davidloeffler):

 This looks great: applies fine to 3.4.1.rc2, all doctests pass, and
 documentation builds happily.

 I've made a few slight adjustments to the formatting (mainly enforcing a
 consistent convention that INPUT: is always followed by a bulleted list
 and OUTPUT: never is, which was true for most but not all of the new
 doctests), and I've added an x == loads(dumps(x)) doctest for each of the
 classes that are actually intended for direct use. (There was a
 loads(dumps()) test in the file already, so sage -coverage didn't protest,
 but it was commented out, and it was for a different class anyway.)

 John: if you're happy with the changes I've made, feel free to change this
 to "positive review".

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/5734#comment:3>
Sage <http://sagemath.org/>
Sage - Open Source Mathematical Software: Building the Car Instead of 
Reinventing the Wheel

--~--~---------~--~----~------------~-------~--~----~
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