]> granicus.if.org Git - python/commitdiff
Updated the doc strings to refer to PyArg_Parse and Py_BuildValue in stead
authorJack Jansen <jack.jansen@cwi.nl>
Fri, 24 Jan 2003 09:23:13 +0000 (09:23 +0000)
committerJack Jansen <jack.jansen@cwi.nl>
Fri, 24 Jan 2003 09:23:13 +0000 (09:23 +0000)
of getargs() and mkvalue().

Tools/bgen/bgen/bgenType.py

index 8ac3ac3019ec01a49f6bd45419efbd35886c2337..aa87aee0328996b2e5e348ecf7cdaf9a10169b04 100644 (file)
@@ -30,14 +30,15 @@ class Type:
         return self.getargsFormat(), self.getargsArgs()
 
     def getargsFormat(self):
-        """Return the format for this type for use with [new]getargs().
+        """Return the format for this type for use with PyArg_Parse().
 
         Example: int.getargsFormat() returns the string "i".
+        (getargs is a very old name for PyArg_Parse, hence the name of this method).
         """
         return self.fmt
 
     def getargsArgs(self, name):
-        """Return an argument for use with [new]getargs().
+        """Return an argument for use with PyArg_Parse().
 
         Example: int.getargsArgs("spam") returns the string "&spam".
         """
@@ -79,15 +80,17 @@ class Type:
         return self.mkvalueFormat(), self.mkvalueArgs()
 
     def mkvalueFormat(self):
-        """Return the format for this type for use with mkvalue().
+        """Return the format for this type for use with Py_BuildValue().
 
         This is normally the same as getargsFormat() but it is
         a separate function to allow future divergence.
+        (mkvalue is a very old name for Py_BuildValue, hence the name of this
+        method).
         """
         return self.getargsFormat()
 
     def mkvalueArgs(self, name):
-        """Return an argument for use with mkvalue().
+        """Return an argument for use with Py_BuildValue().
 
         Example: int.mkvalueArgs("spam") returns the string "spam".
         """