#18959: Poset documentation polishing: integer-valued properties
-------------------------------------+-------------------------------------
Reporter: jmantysalo | Owner:
Type: enhancement | Status: new
Priority: minor | Milestone: sage-6.9
Component: documentation | Resolution:
Keywords: | Merged in:
Authors: Jori Mäntysalo | Reviewers:
Report Upstream: N/A | Work issues:
Branch: | Commit:
u/jmantysalo/poset_documentation_polishing__integer_valued_properties|
1a21f1f475656fa62525f4acef7790c0857bd963
Dependencies: | Stopgaps:
-------------------------------------+-------------------------------------
Changes (by {'newvalue': u'Jori M\xe4ntysalo', 'oldvalue': ''}):
* cc: ncohen (added)
* commit: => 1a21f1f475656fa62525f4acef7790c0857bd963
* author: => Jori Mäntysalo
Comment:
Code changes: Return type of all functions is now `Integer`. There was
slight inconsistency between for example `dimension()` and `width()`.
Tests: Added test for empty poset to those functions where it wasn't
already.
Docstrings: Added some some kind of "human-readable" explanation to
`dimension()`. Otherwise normal things like "returns" -> "return".
Examples: Tried to make simple examples that are possible to verify by
hand. For example `relations_number` for the Pentagon Poset. For
`dimension()` selected a beatiful poset (with untrivial dimension). `:=)`
Questions:
Is it exactly true that "Relations are also often called intervals."? I
would say that every relation (i.e. pair of comparable elemenst) *defines*
an interval.
Is the term 'realizer' commonly used? If so, it should be mentioned in the
documentation of `dimension()` (because of googling).
There is one 'not tested' in `dimension()`. Can a test combine 'long time'
and optional? As it takes less than 30 seconds with additional package, it
could be tested with `--long`.
About English, should one say "the longest chain" or "a longest chain"
when there can be several chains equal in lenght? (Compare to "a smallest
set of linear extensions" on `dimension()`.)
----
New commits:
||[http://git.sagemath.org/sage.git/commit/?id=1a21f1f475656fa62525f4acef7790c0857bd963
1a21f1f]||{{{Some polishing to integer-valued poset properties.}}}||
--
Ticket URL: <http://trac.sagemath.org/ticket/18959#comment:2>
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.