#13891: Default parameters for Graph.plot() and Graph.show()
---------------------------------+------------------------------------------
Reporter: ncohen | Owner: jason, ncohen, rlm
Type: enhancement | Status: needs_review
Priority: major | Milestone: sage-5.7
Component: graph theory | Resolution:
Keywords: | Work issues:
Report Upstream: N/A | Reviewers:
Authors: Nathann Cohen | Merged in:
Dependencies: #13862 | Stopgaps:
---------------------------------+------------------------------------------
Comment (by slabbe):
I tested the patch. All tests passed. Documentation builds fine. The
intended behavior works well for me. Although, here are some remarks
below. Mainly, I believe it should be better documented in the doc string
of plot and show methods. I also added some questions...
1. In the documentation of {{{plot}}} method, I do not understand this:
{{{
- Default parameters for this method can also be set through the
:class:`~sage.misc.decorators.options` mechanism.
}}}
Can you provide an example instead? like:
{{{
EXAMPLE:
Default parameters for this method can also be set through the
:class:`~sage.misc.decorators.options` mechanism::
sage: how_should_I_use_the_decoration_mechanism()
}}}
2. Same comment for {{{show}}} method. I prefer to see an example in the
doc which illustrates the utilisation of this default parameters.
3. {{{dictinary}}} still appears
'''The following point are just questions...'''
A. Somebody can explain me what is the specification differences between
{{{show}}} and {{{plot}}}?
B. Why do you remove the element from the kwds? Is there some efficiency
gain?
{{{
14511 # This dictinary only contains the options that graphplot
14512 # understands. These options are removed from kwds at the
same
14513 # time.
14514 plot_kwds = {k:kwds.pop(k) for k in graphplot_options if k
in kwds}
}}}
C. Should not `{}` be the default ? In genereal, this should be a dict. I
guess None is fine.
{{{
"edge_colors" : None,
}}}
D. What is this?
{{{
69 Methods and classes
70 -------------------
71 .. autofunction:: _circle_embedding
72 .. autofunction:: _line_embedding
}}}
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/13891#comment:16>
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 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.
