Ticket #14141: trac_14141-documentation-for-plotting-fs.patch

sage/combinat/knutson_tao_puzzles.py

@@ -1435 +1435 @@
         sage: f[1, 2]
         1/\0  0\/1
 
+
+    There are various methods and options to display puzzle solutions.
+    A single puzzle can be displayed using the plot method of the puzzle::
+
+        sage: ps = KnutsonTaoPuzzleSolver("H")
+        sage: puzzle = ps('0101','1001')[0]
+        sage: puzzle.plot()  #not tested
+        sage: puzzle.plot(style='fill')  #not tested
+        sage: puzzle.plot(style='edges')  #not tested
+
+    To plot several puzzle solutions, use the plot method of the puzzle
+    solver::
+
+        sage: ps = KnutsonTaoPuzzleSolver('K')
+        sage: solns = ps('0101', '0101')
+        sage: ps.plot(solns)        # not tested
+
+    The code can also generate a PDF of a puzzle (using LaTeX and *tikz*)::
+
+        sage: latex.extra_preamble(r'''\usepackage{tikz}''')
+        sage: ps = KnutsonTaoPuzzleSolver('H')
+        sage: solns = ps('0101', '0101')
+        sage: view(solns[0], viewer='pdf', tightpage=True)  # not tested
+
+
     Below are examples of using each of the currently supported puzzles.
 
     Cohomology of the Grassmannian::
@@ -1771 +1796 @@
             sage: ps.plot(solns)        # not tested
         """
         g = [p.plot() for p in puzzles]
-        # FIXME : is this a bug in Sage or my mistake?
         m = len([gg.axes(False) for gg in g])
         return graphics_array(g, (m+3)/4, 4)