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

docs for the property option of graphs() should include a pointer to the docs for the augment parameter #6210

Closed
jasongrout opened this issue Jun 4, 2009 · 7 comments

Comments

@jasongrout
Copy link
Member

A sentence in the docs for the property parameter should say something about possibly missing graphs, due to the reasons explained in the docs for the augment parameter. See http://groups.google.com/group/sage-devel/browse_thread/thread/e8516faf818a6fb7

Component: documentation

Author: Douglas McNeil

Reviewer: Nathann Cohen, Dmitrii Pasechnik

Merged: sage-4.7.2.rc0

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

@sagetrac-dsm
Copy link
Mannequin

sagetrac-dsm mannequin commented Mar 10, 2011

comment:1

Attachment: trac_6210_clarify_graphs_property_argument.patch.gz

I just got bitten by this..

@sagetrac-dsm sagetrac-dsm mannequin added the s: needs review label Mar 10, 2011
@nathanncohen
Copy link
Mannequin

nathanncohen mannequin commented May 2, 2011

comment:3

Hello !!!

It's true that this part's tricky, but what about just saying after

``property`` -- (default: ``lambda x: True``) any property to be tested on graphs before generation

Something like "The property must fill an inheritance property to work as intended. Please refer to the help of parameter augment" ?

Otherwise the explanations are given twice and we're sure users will read them :-)

Nathann

@kini
Copy link
Collaborator

kini commented Oct 14, 2011

comment:4

We got bitten too, in our undergrad course :) I think I agree with Nathann.

@dimpase
Copy link
Member

dimpase commented Oct 15, 2011

comment:5

Replying to @kini:

We got bitten too, in our undergrad course :) I think I agree with Nathann.

better more, than less...

@jdemeyer
Copy link

Author: Douglas McNeil

@jdemeyer
Copy link

Reviewer: Nathann Cohen, Dmitrii Pasechnik

@jdemeyer
Copy link

Merged: sage-4.7.2.rc0

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

4 participants