[Plplot-cvs] SF.net SVN: plplot:[12133] trunk/doc/docbook/src/api.xml

[<ai...@us...>]

Revision: 12133
          http://plplot.svn.sourceforge.net/plplot/?rev=12133&view=rev
Author:   airwin
Date:     2012-01-16 18:39:42 +0000 (Mon, 16 Jan 2012)
Log Message:
-----------
We definitely don't want a type since this is Python syntax.
Furthermore, now that I have investigated a bit further, I think the
literal tags should surround the whole Python assignment statement. 
The result validates, but I haven't looked at the actual generated
documentation yet.  

As far as I know, this is our first attempt to deal in the redacted
form with the assignment statements that some languages (such as
Python, Perl, and Octave) use to handle C output arguments.  So this
needs further review as we gain experience with those languages for
the PLplot functions that have output arguments (plgriddata, plgdev,
plgfnam, plgdev for the arrays, and many more functions that output
single-variable arguments.)

Modified Paths:
--------------
    trunk/doc/docbook/src/api.xml

Modified: trunk/doc/docbook/src/api.xml
===================================================================
--- trunk/doc/docbook/src/api.xml	2012-01-16 12:27:40 UTC (rev 12132)
+++ trunk/doc/docbook/src/api.xml	2012-01-16 18:39:42 UTC (rev 12133)
@@ -5019,7 +5019,7 @@
 	</listitem>
 	<listitem>
 	  <para>
-	    Python: <literal>PLFLT **</literal><parameter>zg</parameter>=<function>plgriddata(x, y, z, xg, yg, type, data)</function>
+	    Python: <literal><parameter>zg</parameter>=<function>plgriddata(x, y, z, xg, yg, type, data)</function></literal>
 	  </para>
 	</listitem>
       </itemizedlist>

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.