#14124: Minor nitpicks on the docstring for Family
-----------------------------+----------------------------------------------
Reporter: darij | Owner: sage-combinat
Type: defect | Status: new
Priority: trivial | Milestone: sage-5.8
Component: combinatorics | Keywords: sets, family, doc
Work issues: | Report Upstream: N/A
Reviewers: | Authors:
Merged in: | Dependencies:
Stopgaps: |
-----------------------------+----------------------------------------------
{{{
sage: Family?
String Form: <function Family at 0x92abe64>
Namespace: Interactive
Loaded File: /home/darij/sage-5.6/local/lib/python2.7/site-
packages/sage/sets/family.py
Source File: /home/darij/sage-5.6/devel/sage/sage/sets/family.py
Definition: Family(indices, function=None, hidden_keys=[],
hidden_function=None, lazy=False, name=None)
Docstring:
A Family is an associative container which models a family (f_i)_{i
in I}. Then, f[i] returns the element of the family indexed by i.
Whenever available, set and combinatorial class operations
(counting, iteration, listing) on the family are induced from those
of the index set.
There are several available implementations (classes) for different
usages; Family serves as a factory, and will create instances of
the appropriate classes depending on its arguments.
EXAMPLES:
In its simplest form, a list l or a tuple by itself is considered
as the family (l[i]_{i in I}) where I is the range 0...,len(l).
So Family(l) returns the corresponding family:
}}}
Of course, the range should be 0, ..., len(i)-1.
I'm missing the info that families are immutable. Or are they not? Not
exactly understanding the idea of a factory.
Add closing parenthesis in:
{{{
value (ie: "False" for finite data structures and "True" for
enumerated sets:
}}}
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/14124>
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?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
