#16677: improve the docstrings in the finite state machines module
-------------------------------------+-------------------------------------
       Reporter:  dkrenn             |        Owner:
           Type:  enhancement        |       Status:  new
       Priority:  major              |    Milestone:  sage-6.3
      Component:  finite state       |   Resolution:
  machines                           |    Merged in:
       Keywords:                     |    Reviewers:  Clemens Heuberger,
        Authors:  Clemens            |  Daniel Krenn
  Heuberger, Daniel Krenn            |  Work issues:
Report Upstream:  N/A                |       Commit:
         Branch:  u/dkrenn/fsm       |  7944470ff9f487929b86ac3d1d3bcffb486acf5d
  /docs-improved-new                 |     Stopgaps:
   Dependencies:                     |
-------------------------------------+-------------------------------------
Changes (by {'newvalue': u'Clemens Heuberger, Daniel Krenn', 'oldvalue': ''}):

 * reviewer:   => Clemens Heuberger, Daniel Krenn
 * commit:   => 7944470ff9f487929b86ac3d1d3bcffb486acf5d
 * author:   => Clemens Heuberger, Daniel Krenn


Old description:

> The aim of this ticket is to collect various improvements to the
> docstring of the finite state machines module

New description:

 The aim of this ticket is to collect various improvements to the docstring
 of the finite state machines module.

--

Comment:

 Last 10 new commits:
 
||[http://git.sagemath.org/sage.git/commit/?id=adf99b3c39bbdde431b97c2a3a9ef3caaf61a774
 adf99b3]||{{{updated AUTHOR-section}}}||
 
||[http://git.sagemath.org/sage.git/commit/?id=511883c75db00224a737ca450c9aaedf2b885164
 511883c]||{{{state-hooks explained}}}||
 
||[http://git.sagemath.org/sage.git/commit/?id=f6e5189dbb87479f4ad64a14ea6cd1fb023a9c74
 f6e5189]||{{{rewrite first few examples to avoid
 FSMState/FSMTransition}}}||
 
||[http://git.sagemath.org/sage.git/commit/?id=ad847f86a64dcf2bf2870e80933954f5ae68bda4
 ad847f8]||{{{Corrected a few typos}}}||
 
||[http://git.sagemath.org/sage.git/commit/?id=97fe1b60bef8a6be5c0c85cf8a233d83c4201240
 97fe1b6]||{{{finite_state_machine: added a few internal hyperlinks to
 documentation}}}||
 
||[http://git.sagemath.org/sage.git/commit/?id=680d0a61810ab2a67e8eb58d6b59a145156dd97f
 680d0a6]||{{{FSMState: Documentation for attribute is_initial added}}}||
 
||[http://git.sagemath.org/sage.git/commit/?id=4442ce386f7c5fb38687011b7d9abeb0c94f61f2
 4442ce3]||{{{finite_state_machine.py: Started TOC for documentation}}}||
 
||[http://git.sagemath.org/sage.git/commit/?id=4b66e84c8bd78154aa6270eaa2081cdb4f818dd3
 4b66e84]||{{{TOC now lists all methods and attributes}}}||
 
||[http://git.sagemath.org/sage.git/commit/?id=f2c3d649383f8ea21cbfd067a0990d9f5a86e58a
 f2c3d64]||{{{document attribute on_duplicate_transition}}}||
 
||[http://git.sagemath.org/sage.git/commit/?id=7944470ff9f487929b86ac3d1d3bcffb486acf5d
 7944470]||{{{inserted/removed spacings and empty lines}}}||

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