#14132: documentation for matrix( ) mentions ncols and nrows
--------------------------------------+-------------------------------------
       Reporter:  ManDay              |         Owner:  mvngu       
           Type:  defect              |        Status:  needs_review
       Priority:  major               |     Milestone:  sage-5.8    
      Component:  documentation       |    Resolution:              
       Keywords:  matrix ncols nrows  |   Work issues:              
Report Upstream:  N/A                 |     Reviewers:              
        Authors:                      |     Merged in:              
   Dependencies:                      |      Stopgaps:              
--------------------------------------+-------------------------------------
Changes (by ManDay):

  * status:  needs_info => needs_review


Comment:

 A misinterpreation on my side. I blame the (once again) awful/nonexisting
 formalisation of documentation, though (which is hardly the fault of the
 authors but rather owing to that abominable piece of so-proclaimed
 ''software'', "Sphinx").

 The prose part of the documentation does indeed say "''The ring, number of
 rows, and number of columns of the matrix can be specified by setting the
 ring, nrows, or ncols parameters or by passing them as the first arguments
 to the function in the order ring, nrows, ncols.''", below, then, lists

 '''ring''' - the base ring for the entries of the matrix.

 '''nrows''' - the number of rows in the matrix..

 '''ncols''' - the number of columns in the matrix.

 '''sparse''' - create a sparse matrix. This defaults to True when the
 entries are given as a dictionary, otherwise defaults to False.

 ...as if those were any sort of keywords, although they aren't even
 mentioned in the function header, which, by the most intelligent design of
 "Sphinx" and Python's state of formalisation, only goes

 ''Matrix(*args, * *kwds)''

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