#8266: Improve documentation for word objects
-----------------------------+----------------------------------------------
   Reporter:  slabbe         |       Owner:  slabbe    
       Type:  enhancement    |      Status:  new       
   Priority:  major          |   Milestone:  sage-4.3.3
  Component:  documentation  |    Keywords:            
     Author:                 |    Upstream:  N/A       
   Reviewer:                 |      Merged:            
Work_issues:                 |  
-----------------------------+----------------------------------------------
 Documentation of words and word objects contains only pickle tests and
 lacks good examples :

 {{{
 sage: words?
 ...
 Docstring:

         A class consisting of constructors for several famous words.

         TESTS::

             sage: from sage.combinat.words.word_generators import
 WordGenerator
             sage: MyWordBank = WordGenerator()
             sage: type(loads(dumps(MyWordBank)))
             <class 'sage.combinat.words.word_generators.WordGenerator'>
 }}}


 {{{
 sage: w = Word(range(5))
 sage: w?
 ...
 Docstring:

         TESTS::

             sage: w = Word([0,1,1,0])
             sage: w == loads(dumps(w))
             True
 }}}

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8266>
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