Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

typo in g.automorphism_group documentation, for g a graph; also partition parameter isn't tested anywhere in the docstring #5939

Closed
williamstein opened this issue Apr 29, 2009 · 4 comments

Comments

@williamstein
Copy link
Contributor

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.

Component: graph theory

Author: Robert Miller

Reviewer: Emily Kirkman

Merged: sage-4.1.1.alpha0

Issue created by migration from https://trac.sagemath.org/ticket/5939

@rlmill
Copy link
Mannequin

rlmill mannequin commented Jul 16, 2009

Author: Robert Miller

@rlmill rlmill mannequin added the s: needs review label Jul 16, 2009
@sagetrac-ekirkman
Copy link
Mannequin

sagetrac-ekirkman mannequin commented Jul 18, 2009

comment:2

Attachment: trac_5939.patch.gz

@sagetrac-ekirkman
Copy link
Mannequin

sagetrac-ekirkman mannequin commented Jul 18, 2009

Reviewer: Emily Kirkman

@sagetrac-mvngu
Copy link
Mannequin

sagetrac-mvngu mannequin commented Jul 19, 2009

Merged: sage-4.1.1.alpha0

@sagetrac-mvngu sagetrac-mvngu mannequin closed this as completed Jul 19, 2009
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant