#7980: Implement generic support for parents with (multiple) realizations
------------------------------------------+---------------------------------
Reporter: jbandlow | Owner: nthiery
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-5.0
Component: categories | Keywords: Cernay2012
Work_issues: | Upstream: N/A
Reviewer: Simon King, Florent Hivert | Author: Nicolas M. Thiéry
Merged: | Dependencies: #12484, #12464
------------------------------------------+---------------------------------
Comment(by hivert):
Hi Nicolas,
I just posted a
[http://combinat.sagemath.org/patches/file/a9bb0e6af448/trac_7980
-multiple-realizations-review-fh.patch review patch]
on sage-combinat queue. Here are the main changes
1. This is mostly documentation, except that I changed trivially the code
in
the example, by renaming some parameter names:
- in {{{SubsetAlgebra(S)}}} the parameter S is a set;
- in {{{Fundamental(S)}}}, {{{In(S)}}} and {{{Out(S)}}} it is a
{{{SubsetAlgebra}}};
I was really confused about that reading the code so that I renamed
{{{S}}}
to {{{SAlg}}} in the second case and added an {{{INPUT:}}} field in the
doc
2. The correct markup for see also is the following:
{{{
.. seealso::
bla bla bla
bla bla
}}}
as variants, you can use uppercase as Sphinx markup is not case sensitive.
You
can also put everything on one line if it fits:
{{{
.. SEEALSO:: bla bla bla
}}}
If you put a space as in {{{..see also::}}} then this become a comment and
is
ignored by Sphinx ! This remind me that I should finish #12078 Add an
example
of SEE ALSO
3. There is a missing doctest in my review patch
{{{
sage: A.F() in A.Realizations()
Expected:
True
Got:
False
}}}
I left it on purpose. I realize that the correct doctest is
{{{
sage: A.F() in A.Bases()
Expected:
True
Got:
False
}}}
But it took me quite a lot of thinking understanding that. I think we
should
explain this somewhere, probably where the broken test is.
Please review my numerous doc change, fold the patch if you are Ok with
it.
Florent
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/7980#comment:9>
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.
