Ticket #13891: trac_13891-third_pass.patch

sage/combinat/posets/posets.py

@@ -1399 +1399 @@
             sage: D.show(element_labels=elm_labs)
         """
         self.plot(label_elements=label_elements, element_labels=element_labels,
-            label_font_size=label_font_size,label_font_color=label_font_color,
             vertex_size=vertex_size, vertex_colors=vertex_colors, layout=layout).show(**kwds)
 
     def level_sets(self):

sage/graphs/generic_graph.py

@@ -13800 +13800 @@
         Here is the list of all the available layout options::
 
             sage: from sage.graphs.graph_plot import layout_options
-            sage: list(sorted(layout_options.iteritems()))
-            [('by_component', 'Whether to do the spring layout by connected component -- a boolean.'),
-             ('dim', 'The dimension of the layout -- 2 or 3.'),
-             ('heights', 'A dictionary mapping heights to the list of vertices at this height.'),
-             ('iterations', 'The number of times to execute the spring layout algorithm.'),
-             ('layout', 'A layout algorithm -- one of "acyclic", "circular", "ranked", "graphviz", "planar", "spring", or "tree".'),
-             ('prog', 'Which graphviz layout program to use -- one of "circo", "dot", "fdp", "neato", or "twopi".'),
-             ('save_pos', 'Whether or not to save the computed position for the graph.'),
-             ('spring', 'Use spring layout to finalize the current layout.'),
-             ('tree_orientation', 'The direction of tree branches -- "up" or "down".'),
-             ('tree_root', 'A vertex designation for drawing trees.')]
+            sage: for key, value in list(sorted(layout_options.iteritems())):
+            ...      print "option", key, ":", value
+            option by_component : Whether to do the spring layout by connected component -- a boolean.
+            option dim : The dimension of the layout -- 2 or 3.
+            option heights : A dictionary mapping heights to the list of vertices at this height.
+            option iterations : The number of times to execute the spring layout algorithm.
+            option layout : A layout algorithm -- one of : "acyclic", "circular" (plots the graph with vertices evenly distributed on a circle), "ranked", "graphviz", "planar", "spring" (traditional spring layout, using the graph's current positions as initial positions), or "tree" (the tree will be plotted in levels, depending on minimum distance for the root).
+            option prog : Which graphviz layout program to use -- one of "circo", "dot", "fdp", "neato", or "twopi".
+            option save_pos : Whether or not to save the computed position for the graph.
+            option spring : Use spring layout to finalize the current layout.
+            option tree_orientation : The direction of tree branches -- "up" or "down".
+            option tree_root : A vertex designation for drawing trees. a vertex of the tree to be used as the root for the ``layout="tree"`` option. If no root is specified, then one is chosen at random. Ignored unless ``layout='tree'``
 
         Some of them only apply to certain layout algorithms. For
         details, see :meth:`.layout_acyclic`, :meth:`.layout_planar`,

sage/graphs/graph_plot.py

@@ -72 +72 @@
 for key, value in graphplot_options.iteritems():
     __doc__ += "    ``"+str(key)+"`` | "+str(value)+"\n"
 
+
 __doc__ += """
-
 **Default options**
 
 This module defines two dictionaries containing default options for the
@@ -212 +212 @@
         Wrong input::
 
             sage: graphs.PetersenGraph().plot(kujhfuhf="23")
-            doctest:...: DeprecationWarning: kujhfuhf is not a registered argument forGraphPlot ! Please tell us that if it should be by writing to sage-devel !
+            doctest:...: DeprecationWarning: You provided kujhfuhf as an
+            argument to a function which has always silently ignored its
+            inputs. This method may soon be updated so that the method raises an
+            exception instead of this warning, which will break your code : to
+            be on the safe side, update it !
             ...
         """
         # Setting the default values if needed
@@ -223 +227 @@
         for opt in options:
             if not opt in graphplot_options:
                 from sage.misc.superseded import deprecation
-                deprecation(13891, (str(opt)+" is not a registered argument for"+
-                                      "GraphPlot ! Please tell us that if it "+
-                                      "should be by writing to sage-devel !"))
+                deprecation(13891, ("You provided "+str(opt)+" as an argument to a "
+                                    "function which has always silently ignored "
+                                    "its inputs. This method may soon be updated "
+                                    "so that the method raises an exception "
+                                    "instead of this warning, which will break "
+                                    "your code : to be on the safe side, update it !"))
 
         self._plot_components = {}
         self._nodelist = graph.vertices()
@@ -701 +708 @@
 
         self.plot().show(**kwds)
 
-    def plot(self):
+    def plot(self, **kwds):
         """
         Returns a graphics object representing the (di)graph.
 
@@ -843 +850 @@
             sage: g.add_edges([(0,0,'a'),(0,0,'b'),(0,1,'c'),(0,1,'d'),
             ...     (0,1,'e'),(0,1,'f'),(0,1,'f'),(2,1,'g'),(2,2,'h')])
             sage: g.graphplot(edge_labels=True, color_by_label=True, edge_style='dashed').plot()
+
+        Wrong input (any input) :trac:`13891`::
+
+            sage: graphs.PetersenGraph().graphplot().plot(aertataert=346345345)
+            doctest:...: DeprecationWarning: This method takes no argument ! You may want to give it as an argument to graphplot instead.
+            See http://trac.sagemath.org/13891 for details.
+            <BLANKLINE>
         """
+        # This method takes NO input
+        # This has been added in early 2013. Remove it before my death, please.
+        if kwds:
+            from sage.misc.superseded import deprecation
+            deprecation(13891, "This method takes no argument ! You may want "
+                               "to give it as an argument to graphplot instead.")
+
         G = Graphics()
         for comp in self._plot_components.values():
             if not isinstance(comp, list):
@@ -851 +872 @@
             else:
                 for item in comp:
                     G += item
+
         G.set_axes_range(*(self._graph._layout_bounding_box(self._pos)))
         if self._options['graph_border']:
             xmin = G.xmin()