#5939: typo in g.automorphism_group documentation, for g a graph; also partition
parameter isn't tested anywhere in the docstring
--------------------------+-------------------------------------------------
 Reporter:  was           |       Owner:  rlm     
     Type:  defect        |      Status:  new     
 Priority:  minor         |   Milestone:  sage-4.0
Component:  graph theory  |    Keywords:          
--------------------------+-------------------------------------------------
 There is a typo in the docstring for the graph automorphism function:

 {{{
 ``translation`` - if True, then output includes a a
            dictionary translating from keys == vertices to entries ==
 elements
            of 1,2,...,n (since permutation groups can currently only act
 on
            positive integers).
 }}}

 Notice that it says "includes a a" (a appears twice).

 Also, the doctests in that docstring do not test the partition parameter
 at all, and it seems to me that would be a very important parameter to
 illustrate, especially given that the docstring starts {{{
         Returns the largest subgroup of the automorphism group of the
         (di)graph whose orbit partition is finer than the partition given.
 }}}
 which suggests that the most important thing the reader should know is
 that the automorphism_group computes something associated to a partition.

-- 
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/5939>
Sage <http://sagemath.org/>
Sage - Open Source Mathematical Software: Building the Car Instead of 
Reinventing the Wheel

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"sage-trac" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to 
[email protected]
For more options, visit this group at 
http://groups.google.com/group/sage-trac?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to