#8571: Fix the documentation of abstract methods.
-----------------------------+----------------------------------------------
Reporter: hivert | Owner: mvngu
Type: defect | Status: new
Priority: major | Milestone: sage-5.0
Component: documentation | Keywords: abstract methods
Author: | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
Description changed by hivert:
Old description:
> Currently, the documentation of abstract methods has two annoying
> problems:
> - it doesn't appear when asked with "?"
> - nothing says that they are abstract method in the doc.
> This should be fixed.
New description:
Currently, the documentation of abstract methods has the following
annoying problem, it doesn't appear when asked with "?" from a parent.
{{{
sage: P = Parent(category=CoxeterGroups())
sage: P.index_set?
Object `P.index_set` not found.
sage:
}}}
You have to write:
{{{
sage: CG = CoxeterGroups()
sage: CG.ParentMethods.index_set?
Type: AbstractMethod
Base Class: <class 'sage.misc.abstract_method.AbstractMethod'>
String Form: <abstract method index_set at 0x219a320>
Namespace: Interactive
File: /usr/local/sage/sage/local/lib/python2.6/site-
packages/sage/misc/abstract_method.py
Definition: CG.ParentMethods.index_set(self)
Docstring:
Returns the index set of (the simple reflections of) ``self``, as a
list (or iterable).
Class Docstring:
Constructor for abstract methods
[...]
}}}
This should be fixed.
--
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/8571#comment:1>
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.
