#16677: improve the docstrings in the finite state machines module
-------------------------------------+-------------------------------------
       Reporter:  dkrenn             |        Owner:
           Type:  enhancement        |       Status:  needs_work
       Priority:  major              |    Milestone:  sage-6.3
      Component:  finite state       |   Resolution:
  machines                           |    Merged in:
       Keywords:                     |    Reviewers:  Clemens Heuberger,
  finite_state_machine,              |  Daniel Krenn
  documentation                      |  Work issues:
        Authors:  Clemens            |       Commit:
  Heuberger, Daniel Krenn            |  5964e0abf736c957933e511d40646ac1918a6c9e
Report Upstream:  N/A                |     Stopgaps:
         Branch:  u/cheuberg/fsm     |
  /docs-improved-new                 |
   Dependencies:  #16588             |
-------------------------------------+-------------------------------------
Changes (by vbraun):

 * status:  positive_review => needs_work


Comment:

 There is something wrong with
 {{{
 sage -t --long src/sage/doctest/sources.py
 **********************************************************************
 File "src/sage/doctest/sources.py", line 689, in
 sage.doctest.sources.FileDocTestSource._test_enough_doctests
 Failed example:
     for path, dirs, files in itertools.chain(os.walk('sage'),
 os.walk('doc')): # long time
         path = os.path.relpath(path)
         dirs.sort(); files.sort()
         for F in files:
             _, ext = os.path.splitext(F)
             if ext in ('.py', '.pyx', '.pxi', '.sage', '.spyx', '.rst'):
                 filename = os.path.join(path, F)
                 FDS = FileDocTestSource(filename,
 DocTestDefaults(long=True,optional=True))
                 FDS._test_enough_doctests(verbose=False)
 Expected:
     There are 7 tests in sage/combinat/dyck_word.py that are not being run
     There are 6 tests in sage/combinat/interval_posets.py that are not
 being run
     There are 18 tests in sage/combinat/partition.py that are not being
 run
     There are 15 tests in sage/combinat/permutation.py that are not being
 run
     There are 14 tests in sage/combinat/skew_partition.py that are not
 being run
     There are 18 tests in sage/combinat/tableau.py that are not being run
     There are 8 tests in sage/combinat/crystals/tensor_product.py that are
 not being run
     There are 11 tests in
 sage/combinat/rigged_configurations/rigged_configurations.py that are not
 being run
     There are 15 tests in sage/combinat/root_system/cartan_type.py that
 are not being run
     There are 8 tests in sage/combinat/root_system/type_A.py that are not
 being run
     There are 8 tests in sage/combinat/root_system/type_G.py that are not
 being run
     There are 3 unexpected tests being run in sage/doctest/parsing.py
     There are 1 unexpected tests being run in sage/doctest/reporting.py
     There are 9 tests in sage/graphs/graph_plot.py that are not being run
     There are 3 tests in sage/rings/invariant_theory.py that are not being
 run
 Got:
     There are 7 tests in sage/combinat/dyck_word.py that are not being run
     There are 4 tests in sage/combinat/finite_state_machine.py that are
 not being run
     There are 6 tests in sage/combinat/interval_posets.py that are not
 being run
     There are 18 tests in sage/combinat/partition.py that are not being
 run
     There are 15 tests in sage/combinat/permutation.py that are not being
 run
     There are 14 tests in sage/combinat/skew_partition.py that are not
 being run
     There are 18 tests in sage/combinat/tableau.py that are not being run
     There are 8 tests in sage/combinat/crystals/tensor_product.py that are
 not being run
     There are 11 tests in
 sage/combinat/rigged_configurations/rigged_configurations.py that are not
 being run
     There are 15 tests in sage/combinat/root_system/cartan_type.py that
 are not being run
     There are 8 tests in sage/combinat/root_system/type_A.py that are not
 being run
     There are 8 tests in sage/combinat/root_system/type_G.py that are not
 being run
     There are 3 unexpected tests being run in sage/doctest/parsing.py
     There are 1 unexpected tests being run in sage/doctest/reporting.py
     There are 9 tests in sage/graphs/graph_plot.py that are not being run
     There are 3 tests in sage/rings/invariant_theory.py that are not being
 run
 **********************************************************************
 1 item had failures:
    1 of   9 in
 sage.doctest.sources.FileDocTestSource._test_enough_doctests
     [337 tests, 1 failure, 57.03 s]
 }}}

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