#7477: Matroids
----------------------------------------------------+-----------------------
       Reporter:  ncohen                            |         Owner:  jkantor   
  
           Type:  enhancement                       |        Status:  
needs_review
       Priority:  major                             |     Milestone:  sage-5.10 
  
      Component:  combinatorics                     |    Resolution:            
  
       Keywords:                                    |   Work issues:            
  
Report Upstream:  N/A                               |     Reviewers:            
  
        Authors:  Stefan van Zwam, Rudi Pendavingh  |     Merged in:            
  
   Dependencies:  #14669                            |      Stopgaps:            
  
----------------------------------------------------+-----------------------

Comment (by yomcat):

 I made most of the changes detailed below (I'll leave it to Stefan to
 upload and make sure I didn't break anything)

 Replying to [comment:55 rbeezer]:
 > 1.  I'm not too dogmatic about long lines in doctests, but an effort
 should be made to line-break both input and output in the cases where it
 goes on forever.

 You haven't got to catalog.py yet (it's horrible for this), but is there a
 general guideline on characters per line?

 > 1.  Lots of "simple" methods without OUTPUT sections.  Yes, it seems
 silly to just say "foo() returns all the foo's of the matroid."  I like to
 provide some very basic idea of what a foo is if possible, then the
 documentation seems worthwhile.  I've learned a lot of math by reading
 Sage documentation.

 I changed all of those that I am able to (some I don't know what they
 are).

 >
 >   Code:  "If that fails, we simply use a list `[0..m-1]`"
 >   The single backticks are giving TeX, this should definitely be code,
 hence two backticks
 >   Probably the (i,j) preceding is similar, though we could debate if
 that is math or code.

 There were lots like this, so I left them as they are, as that's a debate
 I don't really want to have.

 >
 >   f-vector() documentation:
 >     Has a list with just one item for output.  Probably does not need to
 be a list.  Ditto for flats().  I'm seeing more like this.  I'm inclined
 to just write a paragraph, unless returning a pair, triple, or ...

 I'm confused. f_vector() returns a list [f_0, ..., f_r] where f_i is the
 number of flats of rank i, and r the rank of the matroid. That's got more
 than one thing in it. And flats() returns a SetSystem, not a list, and
 there's normally a lot more than one flat at a given rank.


 Michael

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/7477#comment:56>
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.


Reply via email to