#11536: Add warning or optional or something to TransitiveGroups doc
-----------------------------+----------------------------------------------
Reporter: kcrisman | Owner: mvngu
Type: defect | Status: new
Priority: minor | Milestone: sage-4.7.1
Component: documentation | Keywords: beginner
Work_issues: | Upstream: N/A
Reviewer: | Author:
Merged: | Dependencies:
-----------------------------+----------------------------------------------
The documentation for !TransitiveGroups is misleading.
{{{
Warning: TransitiveGroups requires the optional GAP database
package. Please install it with ``sage -i database_gap``.
EXAMPLES:
sage: TransitiveGroups(3)
Transitive Groups of degree 3
sage: TransitiveGroups(7)
Transitive Groups of degree 7
sage: TransitiveGroups(8)
Transitive Groups of degree 8
}}}
Note these are not marked `# optional`. The only one which is is one for
degree 31!
Further, the warning is buried by the error.
{{{
sage: TransitiveGroups(3)
Transitive Groups of degree 3
sage: for g in TransitiveGroups(3):
....: g
....:
verbose 0 (1182: permgroup_named.py, cardinality) Warning:
TransitiveGroups requires the GAP database package. Please install it with
``sage -i database_gap``.
1175 [Transitive group number 1 of degree 5, Transitive
group number 2 of degree 5, Transitive group number 3 of degree 5,
Transitive group number 4 of degree 5, Transitive group number 5 of degree
5]
1176 """
-> 1177 for n in xrange(1, self.cardinality() + 1):
1178 yield self[n]
1179
TypeError: unsupported operand type(s) for +: 'NoneType' and 'int'
}}}
I'm not suggesting we change the behavior of `TransitiveGroups(3)`, since
one can install the database from within an active Sage session. But the
errors need to be better, or the doc needs to make it clearer what will
happen when you do it without the database (hard to test for ''not''
having an optional package, I know), or both. Take your pick!
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/11536>
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.
