#17979: Reimplementation of IntegerListsLex
-------------------------------------+-------------------------------------
       Reporter:  aschilling         |        Owner:
           Type:  defect             |       Status:  needs_work
       Priority:  blocker            |    Milestone:  sage-6.6
      Component:  combinatorics      |   Resolution:
       Keywords:  days64             |    Merged in:
        Authors:  Bryan Gillespie,   |    Reviewers:  Nathann Cohen, Jeroen
  Anne Schilling, Nicolas M. Thiery  |  Demeyer, Travis Scrimshaw
Report Upstream:  N/A                |  Work issues:
         Branch:                     |       Commit:
  public/ticket/17979                |  8c6d433b54d953f877f37accdb2292dbde05e01a
   Dependencies:                     |     Stopgaps:
-------------------------------------+-------------------------------------

Comment (by nthiery):

 Replying to [comment:412 ncohen]:
 Also, let me write somewhere that I
 >  am against keeping `integer_list_old` in Sage, as I am afraid that
 >  it will still be here several years from now.

 We definitely should keep it around for benchmarking purposes at least
 until #18055 is finished. I am fine adding the removal of
 `integer_list_old` to the todo list for this ticket.

 >  - Documentation of `IntegerListsLex`: instead of stating the
 >  *purpose* of the class (which is more something one would explain
 >  on a trac ticket),
 >  what about
 >    a SEEALSO section? I have the following paragraph in mind:
 >    {{{
 >    The main purpose is to provide a generic iteration engine for all
 >    the enumerated sets like :class:`Partitions`,
 >    class:`Compositions`, :class:`IntegerVectors`. It can also be
 >    used to generate many other combinatorial objects like Dyck paths,
 >    Motzkin paths, etc.
 >    }}}
 >    I thought that it would make more sense as a SEEALSO section pointing
 >  toward
 >    the mentionned objects.

 A user reading this documentation is likely to know about integer
 partitions, compositions or such. Mentioning them early on gives
 immediately an idea of the range of applications, and thus a better
 understanding of the upcoming description of the specific input.  So I
 would want this text to come before the long description of the input.
 I am fine making it into a SEEALSO if that's ok to put one before
 INPUT.

 Also it's also a useful piece of information for users, even more for
 developers, to better understand the architecture, and know when to
 use this class or another one.  Such information really belongs to the
 documentation, not trac.

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