Documentation updates: Replaced "string" with "str".

This commit is contained in:
2010-05-28 18:42:11 +00:00
parent 11e8782d01
commit db158b42de
33 changed files with 43 additions and 43 deletions

View File

@@ -77,7 +77,7 @@ static char BinaryPredicate0D_getName___doc__[] =
" Returns the name of the binary 0D predicate.\n"
"\n"
" :return: The name of the binary 0D predicate.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * BinaryPredicate0D_getName( BPy_BinaryPredicate0D *self, PyObject *args)
{

View File

@@ -106,7 +106,7 @@ static char BinaryPredicate1D_getName___doc__[] =
" Returns the name of the binary 1D predicate.\n"
"\n"
" :return: The name of the binary 1D predicate.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject *BinaryPredicate1D_getName( BPy_BinaryPredicate1D *self, PyObject *args)
{

View File

@@ -59,9 +59,9 @@ static char ContextFunctions_LoadMapCF___doc__[] =
" Loads an image map for further reading.\n"
"\n"
" :arg iFileName: The name of the image file.\n"
" :type iFileName: string\n"
" :type iFileName: str\n"
" :arg iMapName: The name that will be used to access this image.\n"
" :type iMapName: string\n"
" :type iMapName: str\n"
" :arg iNbLevels: The number of levels in the map pyramid\n"
" (default = 4). If iNbLevels == 0, the complete pyramid is\n"
" built.\n"
@@ -90,7 +90,7 @@ static char ContextFunctions_ReadMapPixelCF___doc__[] =
" Reads a pixel in a user-defined map.\n"
"\n"
" :arg iMapName: The name of the map.\n"
" :type iMapName: string\n"
" :type iMapName: str\n"
" :arg level: The level of the pyramid in which we wish to read the\n"
" pixel.\n"
" :type level: int\n"

View File

@@ -96,7 +96,7 @@ static char Interface0D_getExactTypeName___doc__[] =
" Returns the name of the 0D element.\n"
"\n"
" :return: Name of the interface.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject *Interface0D_getExactTypeName( BPy_Interface0D *self ) {
return PyUnicode_FromString( self->if0D->getExactTypeName().c_str() );

View File

@@ -106,7 +106,7 @@ static char Interface1D_getExactTypeName___doc__[] =
" Returns the string of the name of the 1D element.\n"
"\n"
" :return: The name of the 1D element.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject *Interface1D_getExactTypeName( BPy_Interface1D *self ) {
return PyUnicode_FromString( self->if1D->getExactTypeName().c_str() );

View File

@@ -107,7 +107,7 @@ static char Iterator_getExactTypeName___doc__[] =
" Returns the name of the iterator.\n"
"\n"
" :return: The name of the iterator.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * Iterator_getExactTypeName(BPy_Iterator* self) {
return PyUnicode_FromString( self->it->getExactTypeName().c_str() );

View File

@@ -250,7 +250,7 @@ static char StrokeAttribute_getAttributeReal___doc__[] =
" Returns an attribute of float type.\n"
"\n"
" :arg iName: The name of the attribute.\n"
" :type iName: string\n"
" :type iName: str\n"
" :return: The attribute value.\n"
" :rtype: float\n";
@@ -270,7 +270,7 @@ static char StrokeAttribute_getAttributeVec2f___doc__[] =
" Returns an attribute of two-dimensional vector type.\n"
"\n"
" :arg iName: The name of the attribute.\n"
" :type iName: string\n"
" :type iName: str\n"
" :return: The attribute value.\n"
" :rtype: :class:`mathutils.Vector`\n";
@@ -290,7 +290,7 @@ static char StrokeAttribute_getAttributeVec3f___doc__[] =
" Returns an attribute of three-dimensional vector type.\n"
"\n"
" :arg iName: The name of the attribute.\n"
" :type iName: string\n"
" :type iName: str\n"
" :return: The attribute value.\n"
" :rtype: :class:`mathutils.Vector`\n";
@@ -310,7 +310,7 @@ static char StrokeAttribute_isAttributeAvailableReal___doc__[] =
" Checks whether the attribute iName of float type is available.\n"
"\n"
" :arg iName: The name of the attribute.\n"
" :type iName: string\n"
" :type iName: str\n"
" :return: True if the attribute is availbale.\n"
" :rtype: bool\n";
@@ -330,7 +330,7 @@ static char StrokeAttribute_isAttributeAvailableVec2f___doc__[] =
" is available.\n"
"\n"
" :arg iName: The name of the attribute.\n"
" :type iName: string\n"
" :type iName: str\n"
" :return: True if the attribute is availbale.\n"
" :rtype: bool\n";
@@ -350,7 +350,7 @@ static char StrokeAttribute_isAttributeAvailableVec3f___doc__[] =
" type is available.\n"
"\n"
" :arg iName: The name of the attribute.\n"
" :type iName: string\n"
" :type iName: str\n"
" :return: True if the attribute is availbale.\n"
" :rtype: bool\n";
@@ -507,7 +507,7 @@ static char StrokeAttribute_setAttributeReal___doc__[] =
" replaces the old one.\n"
"\n"
" :arg iName: The name of the attribute.\n"
" :type iName: string\n"
" :type iName: str\n"
" :arg att: The attribute value.\n"
" :type att: float\n";
@@ -530,7 +530,7 @@ static char StrokeAttribute_setAttributeVec2f___doc__[] =
" the new value replaces the old one.\n"
"\n"
" :arg iName: The name of the attribute.\n"
" :type iName: string\n"
" :type iName: str\n"
" :arg att: The attribute value.\n"
" :type att: :class:`mathutils.Vector`, list or tuple of 2 real numbers\n";
@@ -559,7 +559,7 @@ static char StrokeAttribute_setAttributeVec3f___doc__[] =
" Otherwise, the new value replaces the old one.\n"
"\n"
" :arg iName: The name of the attribute.\n"
" :type iName: string\n"
" :type iName: str\n"
" :arg att: The attribute value.\n"
" :type att: :class:`mathutils.Vector`, list or tuple of 3 real numbers\n";

View File

@@ -205,7 +205,7 @@ static char StrokeShader_getName___doc__[] =
" Returns the name of this stroke shader.\n"
"\n"
" :return: The name of this stroke shader.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * StrokeShader_getName( BPy_StrokeShader *self, PyObject *args)
{

View File

@@ -86,7 +86,7 @@ static char UnaryPredicate0D_getName___doc__[] =
" Returns the name of the UnaryPredicate0D.\n"
"\n"
" :return: The name of the UnaryPredicate0D.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryPredicate0D_getName( BPy_UnaryPredicate0D *self )
{

View File

@@ -132,7 +132,7 @@ static char UnaryPredicate1D_getName___doc__[] =
" EqualToChainingTimeStampUP1D, ShapeUP1D, and DensityLowerThanUP1D.\n"
"\n"
" :return: \n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryPredicate1D_getName( BPy_UnaryPredicate1D *self, PyObject *args)
{

View File

@@ -20,7 +20,7 @@ static char ColorVariationPatternShader___doc__[] =
"\n"
" :arg pattern_name: The file name of the texture file to use as\n"
" pattern.\n"
" :type pattern_name: string\n"
" :type pattern_name: str\n"
" :arg stretch: Tells whether the texture must be strecthed or\n"
" repeted to fit the stroke.\n"
" :type stretch: bool\n"

View File

@@ -20,7 +20,7 @@ static char StrokeTextureShader___doc__[] =
" Builds a StrokeTextureShader object.\n"
"\n"
" :arg textureFile: \n"
" :type textureFile: string\n"
" :type textureFile: str\n"
" :arg mediumType: The medium type and therefore, the blending mode\n"
" that must be used for the rendering of this stroke.\n"
" :type mediumType: :class:`MediumType`\n"

View File

@@ -19,7 +19,7 @@ static char ThicknessVariationPatternShader___doc__[] =
" Builds a ThicknessVariationPatternShader object.\n"
"\n"
" :arg pattern_name: The texture file name.\n"
" :type pattern_name: string\n"
" :type pattern_name: str\n"
" :arg iMinThickness: The minimum thickness we don't want to exceed.\n"
" :type iMinThickness: float\n"
" :arg iMaxThickness: The maximum thickness we don't want to exceed.\n"

View File

@@ -18,7 +18,7 @@ static char fstreamShader___doc__[] =
" Builds a fstreamShader object.\n"
"\n"
" :arg iFileName: The output file name.\n"
" :type iFileName: string\n"
" :type iFileName: str\n"
"\n"
".. method:: shade(s)\n"
"\n"

View File

@@ -124,7 +124,7 @@ static char UnaryFunction0DDouble_getName___doc__[] =
" Returns the name of the unary 0D predicate.\n"
"\n"
" :return: The name of the unary 0D predicate.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction0DDouble_getName( BPy_UnaryFunction0DDouble *self )
{

View File

@@ -68,7 +68,7 @@ static char UnaryFunction0DEdgeNature_getName___doc__[] =
" Returns the name of the unary 0D predicate.\n"
"\n"
" :return: The name of the unary 0D predicate.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction0DEdgeNature_getName( BPy_UnaryFunction0DEdgeNature *self )
{

View File

@@ -98,7 +98,7 @@ static char UnaryFunction0DFloat_getName___doc__[] =
" Returns the name of the unary 0D predicate.\n"
"\n"
" :return: The name of the unary 0D predicate.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction0DFloat_getName( BPy_UnaryFunction0DFloat *self )
{

View File

@@ -68,7 +68,7 @@ static char UnaryFunction0DId_getName___doc__[] =
" Returns the name of the unary 0D predicate.\n"
"\n"
" :return: The name of the unary 0D predicate.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction0DId_getName( BPy_UnaryFunction0DId *self )
{

View File

@@ -69,7 +69,7 @@ static char UnaryFunction0DMaterial_getName___doc__[] =
" Returns the name of the unary 0D predicate.\n"
"\n"
" :return: The name of the unary 0D predicate.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction0DMaterial_getName( BPy_UnaryFunction0DMaterial *self )
{

View File

@@ -68,7 +68,7 @@ static char UnaryFunction0DUnsigned_getName___doc__[] =
" Returns the name of the unary 0D predicate.\n"
"\n"
" :return: The name of the unary 0D predicate.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction0DUnsigned_getName( BPy_UnaryFunction0DUnsigned *self )
{

View File

@@ -74,7 +74,7 @@ static char UnaryFunction0DVec2f_getName___doc__[] =
" Returns the name of the unary 0D predicate.\n"
"\n"
" :return: The name of the unary 0D predicate.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction0DVec2f_getName( BPy_UnaryFunction0DVec2f *self )
{

View File

@@ -68,7 +68,7 @@ static char UnaryFunction0DVec3f_getName___doc__[] =
" Returns the name of the unary 0D predicate.\n"
"\n"
" :return: The name of the unary 0D predicate.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction0DVec3f_getName( BPy_UnaryFunction0DVec3f *self )
{

View File

@@ -69,7 +69,7 @@ static char UnaryFunction0DVectorViewShape_getName___doc__[] =
" Returns the name of the unary 0D predicate.\n"
"\n"
" :return: The name of the unary 0D predicate.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction0DVectorViewShape_getName( BPy_UnaryFunction0DVectorViewShape *self )
{

View File

@@ -74,7 +74,7 @@ static char UnaryFunction0DViewShape_getName___doc__[] =
" Returns the name of the unary 0D predicate.\n"
"\n"
" :return: The name of the unary 0D predicate.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction0DViewShape_getName( BPy_UnaryFunction0DViewShape *self )
{

View File

@@ -16,7 +16,7 @@ static char ReadMapPixelF0D___doc__[] =
" Builds a ReadMapPixelF0D object.\n"
"\n"
" :arg iMapName: The name of the map to be read.\n"
" :type iMapName: string\n"
" :type iMapName: str\n"
" :arg level: The level of the pyramid from which the pixel must be\n"
" read.\n"
" :type level: int\n"

View File

@@ -165,7 +165,7 @@ static char UnaryFunction1DDouble_getName___doc__[] =
" Returns the name of the unary 1D function.\n"
"\n"
" :return: The name of the unary 1D function.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction1DDouble_getName( BPy_UnaryFunction1DDouble *self )
{

View File

@@ -86,7 +86,7 @@ static char UnaryFunction1DEdgeNature_getName___doc__[] =
" Returns the name of the unary 1D function.\n"
"\n"
" :return: The name of the unary 1D function.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction1DEdgeNature_getName( BPy_UnaryFunction1DEdgeNature *self )
{

View File

@@ -79,7 +79,7 @@ static char UnaryFunction1DFloat_getName___doc__[] =
" Returns the name of the unary 1D function.\n"
"\n"
" :return: The name of the unary 1D function.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction1DFloat_getName( BPy_UnaryFunction1DFloat *self )
{

View File

@@ -86,7 +86,7 @@ static char UnaryFunction1DUnsigned_getName___doc__[] =
" Returns the name of the unary 1D function.\n"
"\n"
" :return: The name of the unary 1D function.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction1DUnsigned_getName( BPy_UnaryFunction1DUnsigned *self )
{

View File

@@ -92,7 +92,7 @@ static char UnaryFunction1DVec2f_getName___doc__[] =
" Returns the name of the unary 1D function.\n"
"\n"
" :return: The name of the unary 1D function.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction1DVec2f_getName( BPy_UnaryFunction1DVec2f *self )
{

View File

@@ -86,7 +86,7 @@ static char UnaryFunction1DVec3f_getName___doc__[] =
" Returns the name of the unary 1D function.\n"
"\n"
" :return: The name of the unary 1D function.\n"
" :rtype: string\n";
" :rtype: str\n";
PyObject * UnaryFunction1DVec3f_getName( BPy_UnaryFunction1DVec3f *self )
{

View File

@@ -99,7 +99,7 @@ static char UnaryFunction1DVectorViewShape_getName___doc__[] =
" Returns the name of the unary 1D function.\n"
"\n"
" :return: The name of the unary 1D function.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction1DVectorViewShape_getName( BPy_UnaryFunction1DVectorViewShape *self )
{

View File

@@ -99,7 +99,7 @@ static char UnaryFunction1DVoid_getName___doc__[] =
" Returns the name of the unary 1D function.\n"
"\n"
" :return: The name of the unary 1D function.\n"
" :rtype: string\n";
" :rtype: str\n";
static PyObject * UnaryFunction1DVoid_getName( BPy_UnaryFunction1DVoid *self )
{