#16256: Reorganize the documentation indexes into src/sage/combinat
-------------------------------------+-------------------------------------
Reporter: nthiery | Owner:
Type: enhancement | Status: positive_review
Priority: major | Milestone: sage-6.4
Component: documentation | Resolution:
Keywords: combinatorics, | Merged in:
thematic index, quickref | Reviewers: Anne Schilling
Authors: Nicolas M. | Work issues:
Thiéry, Jean-Pierre Flori | Commit:
Report Upstream: N/A | a5208fd118f578f5f36a57caaf43e6a81e48653b
Branch: | Stopgaps:
u/nthiery/ticket/16256 |
Dependencies: #16058, #17189 |
-------------------------------------+-------------------------------------
Comment (by nthiery):
Replying to [comment:116 ncohen]:
> As far as the documentation is concerned, we should have all
> functions appear in the poset index, even those that are implemented
> somewhere else.
Sure. Even more, this should be automatized at some point. But we are
deviating topic.
> There is no systematic way to 'guess' in which file a Poset function
> should be implemented:
It's not so bad, for a developer at least: the question is just
whether the implementation of the function depend on the specific data
structure or not. Well, I am going off topic again.
> so we must keep it simple at least on the user side.
Sure.
> When it comes to the developper's side, it would also be nice if having
categories did not mean having to move functions where they do not belong.
The 'categories/' folder should only contain category code, not Poset-
specific code. Not any kind of mathematical code, actually.
>
> Or perhaps we should move the categories/poset file to combinat/posets ?
That would make more sense to me.
Well, so far the convention, in Sage and in other software with
similar mechanisms, has been to keep all the general purpose
mathematical categories together. This helps keeping them consistent
with each other, keeping an overview of the hierarchy, etc. This could
be changed, but this should be done consistently.
Cheers,
Nicolas
--
Ticket URL: <http://trac.sagemath.org/ticket/16256#comment:117>
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.
