#14912: UniqueRepresentation tutorial could use more love
--------------------------------------------+--------------------
Reporter: darij | Owner:
Type: defect | Status: new
Priority: major | Milestone:
Component: documentation | Resolution:
Keywords: documentation, structure | Merged in:
Authors: | Reviewers:
Report Upstream: N/A | Work issues:
Branch: | Dependencies:
Stopgaps: |
--------------------------------------------+--------------------
Comment (by SimonKing):
Questions:
- Neither `sage.structure.factory` nor
`sage.structure.unique_representation` have a meaningful documentation at
module level. Would it make sense to give documentation at module level
that helps for choosing among the two models of creating a unique parent
behaviour? Or should this be only provided by `CachedRepresentation` and
`UniqueRepresentation` resp. by `UniqueFactory`?
- You mentioned that you find the distinction between `__classcall__` and
`__classcall_private__` unclear. There is an example clarifying the
distinction, but it is hidden in the documentation of `_clear_cache_()`,
which is an underscore method and is thus not visible in the reference
manual. Do you think that the example from `_clear_cache_()` is clear?
Then we could promote it (or a similar example) to a visible place.
--
Ticket URL: <http://trac.sagemath.org/ticket/14912#comment:10>
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/groups/opt_out.
