#5918: [with patch; needs review] bring doctest coverage for posets to 100%
---------------------------+------------------------------------------------
Reporter: saliola | Owner: saliola
Type: task | Status: new
Priority: major | Milestone: sage-3.4.2
Component: combinatorics | Keywords:
---------------------------+------------------------------------------------
Comment(by ddrake):
I'm going to upload a patch which corrects a bunch of typos and formatting
bits. I do have a couple comments:
* before, the definitions for order ideal and filter were both obviously
wrong. I corrected the definition and took the liberty of rewriting it;
please check those.
* you need a blank line between {{{EXAMPLES::}} (or {{{TEST::}}}) and
the first line of the doctest; otherwise, the documentation doesn't get
typeset correctly.
* doing {{{`M\"obius`}}} doesn't work; it automatically uses LaTeX in
math mode, and gets messed up. For now I just removed the backticks. (If
we add a utf-8 encoding declaration, you can use the umlaut and everything
works, but for now, the official rule is that Sage library code is 7-bit
clean.)
Also. there seems to be a lot of duplication between posets.py and
hasse_diagram.py. This makes fixing documentation hard, since you have to
fix things in two places. Is it possible to somehow combine this stuff so
code and documentation doesn't need to be copied? (I'm asking this of
everyone, not necessarily Franco.)
I don't have time for this now, but it would be nice to add cross-
references: you can do stuff like "{{{...see :func:`coolfunction()`
for...}}}" and get automatically linked cross-references.
Finally, this does raise coverage to (basically) 100% and passes all
doctests. I'm glad to see this!
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/5918#comment:5>
Sage <http://sagemath.org/>
Sage - Open Source Mathematical Software: Building the Car Instead of
Reinventing the Wheel
--~--~---------~--~----~------------~-------~--~----~
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
-~----------~----~----~----~------~----~------~--~---
