Opened 10 years ago

Last modified 11 days ago

#14124 needs_review defect

Minor nitpicks on the docstring for Family

Reported by: Darij Grinberg Owned by: Sage Combinat CC user
Priority: trivial Milestone: sage-duplicate/invalid/wontfix
Component: combinatorics Keywords: sets, family, doc
Cc: Merged in:
Authors: Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: #34340 Stopgaps:

Status badges

Description

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:

Change History (5)

comment:1 Changed 9 years ago by Jeroen Demeyer

Milestone: sage-5.11sage-5.12

comment:2 Changed 9 years ago by For batch modifications

Milestone: sage-6.1sage-6.2

comment:3 Changed 8 years ago by For batch modifications

Milestone: sage-6.2sage-6.3

comment:4 Changed 8 years ago by For batch modifications

Milestone: sage-6.3sage-6.4

comment:5 in reply to:  description Changed 11 days ago by Matthias Köppe

Dependencies: #34340
Milestone: sage-6.4sage-duplicate/invalid/wontfix
Status: newneeds_review

Replying to Darij Grinberg:

       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.

That was already fixed as of 9.7.rc2

I'm missing the info that families are immutable.

Added in #34340

Add closing parenthesis in:

       value (ie: "False" for finite data structures and "True" for
       enumerated sets:

Fixed by rephrasing in #34340

Note: See TracTickets for help on using tickets.