Opened 12 years ago

Closed 12 years ago

#5939 closed defect (fixed)

[with patch, positive review] typo in g.automorphism_group documentation, for g a graph; also partition parameter isn't tested anywhere in the docstring

Reported by: was Owned by: rlm
Priority: minor Milestone: sage-4.1.1
Component: graph theory Keywords:
Cc: Merged in: sage-4.1.1.alpha0
Authors: Robert Miller Reviewers: Emily Kirkman
Report Upstream: Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description

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.

Attachments (1)

trac_5939.patch (1.3 KB) - added by rlm 12 years ago.

Download all attachments as: .zip

Change History (5)

comment:1 Changed 12 years ago by rlm

  • Authors set to Robert Miller
  • Summary changed from typo in g.automorphism_group documentation, for g a graph; also partition parameter isn't tested anywhere in the docstring to [with patch, needs review] typo in g.automorphism_group documentation, for g a graph; also partition parameter isn't tested anywhere in the docstring

Changed 12 years ago by rlm

comment:2 Changed 12 years ago by ekirkman

  • Summary changed from [with patch, needs review] typo in g.automorphism_group documentation, for g a graph; also partition parameter isn't tested anywhere in the docstring to [with patch, positive review] typo in g.automorphism_group documentation, for g a graph; also partition parameter isn't tested anywhere in the docstring

comment:3 Changed 12 years ago by ekirkman

  • Reviewers set to Emily Kirkman

comment:4 Changed 12 years ago by mvngu

  • Merged in set to sage-4.1.1.alpha0
  • Resolution set to fixed
  • Status changed from new to closed
Note: See TracTickets for help on using tickets.