[Bf-python] epy doc warnings & errors

Theo de Ridder theo.de.ridder at planet.nl
Sat Mar 29 20:44:54 CET 2008


Cambell,

I looked at all warnings you send:

- most of those are:
	- u'type' expected a single argument
	- @type for unknown parameter "aa,bb"

	this seems to be a bug in EpyDoc 3.0 when using multiple names in a  
single field typespec:
		first warning comes when you use @type  aa, bb, cc:  ...
		second warning comes when you use @type aa,bb,cc:  ...
		(the difference being the spaces after each ',')
	so preventing a warning here requires individual typespecs, which is  
of course clumsy;

	
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/
> | Constraint.py, line 3, in Constraint
> |   Warning: Lines 41, 46: Lists must be indented.
this warning did not appear in my case but I saw an indentation
hierarchy with a few consecutive lines starting with: If ...
I think the original idea was to start these lines with a bullet,
resulting also in a much better layout;

> | File /media/data/render/blender/source/blender/python/api2_2x/doc/
> | Noise.py, line 133, in Noise.vTurbulence
> |   Warning: Line 135: Improper paragraph indentation.
this one is obvious when you look there;

> Warning: Failed identifier crossreference targets:
>         - Constraint.Settings
>               (from Constraint.Constraint.__getitem__)
>               (from Constraint.Constraint.__setitem__)
>         - Type
>               (from Constraint.Constraint.type)
>               (from Constraint.Constraints.append)

I could not reproduce this one, so no suggestion about what it means,

Theo


> |On 19 mrt 2008, at 10:04, Campbell Barton wrote:
> Hey, anyone interested in fixing warnings/errors in epydoc?
>
> quite a few of these errors only occur with epydoc 3.0, but still  
> good to fix.
>
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 143, in BGL.glBitmap
> |   Warning: u'type' expected a single argument
> |   Warning: @type for unknown parameter "xmove,ymove"
> |   Warning: @type for unknown parameter "xorig,yorig"
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 206, in BGL.glClearAccum
> |   Warning: @type for unknown parameter "red,green,blue,alpha"
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 216, in BGL.glClearColor
> |   Warning: @type for unknown parameter "red,green,blue,alpha"
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 267, in BGL.glColor
> |   Warning: @type for unknown parameter "red,green,blue,alpha"
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 284, in BGL.glColorMask
> |   Warning: @type for unknown parameter "red,green,blue,alpha"
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 307, in BGL.glCopyPixels
> |   Warning: u'type' expected a single argument
> |   Warning: @type for unknown parameter "x,y"
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 404, in BGL.glDrawPixels
> |   Warning: u'type' expected a single argument
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 470, in BGL.glEvalMesh
> |   Warning: u'type' expected a single argument
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 548, in BGL.glFrustum
> |   Warning: u'type' expected a single argument
> |   Warning: u'type' expected a single argument
> |   Warning: u'type' expected a single argument
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 940, in BGL.glMap1
> |   Warning: u'type' expected a single argument
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 964, in BGL.glMap2
> |   Warning: u'type' expected a single argument
> |   Warning: u'type' expected a single argument
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1003, in BGL.glMapGrid
> |   Warning: u'type' expected a single argument
> |   Warning: u'type' expected a single argument
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1071, in BGL.glNormal3
> |   Warning: u'type' expected a single argument
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1087, in BGL.glOrtho
> |   Warning: u'type' expected a single argument
> |   Warning: u'type' expected a single argument
> |   Warning: u'type' expected a single argument
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1156, in BGL.glPixelZoom
> |   Warning: u'type' expected a single argument
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1282, in BGL.glRasterPos
> |   Warning: u'type' expected a single argument
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1325, in BGL.glReadPixels
> |   Warning: u'type' expected a single argument
> |   Warning: @type for unknown parameter "x,y"
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1345, in BGL.glRect
> |   Warning: u'type' expected a single argument
> |   Warning: u'type' expected a single argument
> |   Warning: u'type' expected a single argument
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1370, in BGL.glRotate
> |   Warning: @type for unknown parameter "x,y,z"
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1383, in BGL.glScale
> |   Warning: @type for unknown parameter "x,y,z"
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1394, in BGL.glScissor
> |   Warning: u'type' expected a single argument
> |   Warning: @type for unknown parameter "x,y"
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1472, in BGL.glTexCoord
> |   Warning: @type for unknown parameter "s,t,r,q"
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1601, in BGL.glTranslate
> |   Warning: @type for unknown parameter "x,y,z"
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1612, in BGL.glVertex
> |   Warning: @type for unknown parameter "x,y,z,w"
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1631, in BGL.glViewport
> |   Warning: @type for unknown parameter "width,height"
> |   Warning: @type for unknown parameter "x,y"
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1660, in BGL.gluLookAt
> |   Warning: u'type' expected a single argument
> |   Warning: u'type' expected a single argument
> |   Warning: u'type' expected a single argument
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1673, in BGL.gluOrtho2D
> |   Warning: u'type' expected a single argument
> |   Warning: u'type' expected a single argument
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1684, in BGL.gluPickMatrix
> |   Warning: u'type' expected a single argument
> |   Warning: u'type' expected a single argument
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1697, in BGL.gluProject
> |   Warning: u'type' expected a single argument
> |   Warning: u'type' expected a single argument
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/ 
> BGL.py,
> | line 1714, in BGL.gluUnProject
> |   Warning: u'type' expected a single argument
> |   Warning: u'type' expected a single argument
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/
> | Constraint.py, line 3, in Constraint
> |   Warning: Lines 41, 46: Lists must be indented.
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/
> | Noise.py, line 133, in Noise.vTurbulence
> |   Warning: Line 135: Improper paragraph indentation.
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/
> | Texture.py, line 424, in Texture.Texture.setFlags
> |   Warning: @type for unknown parameter "f1,f2,f3,f4"
> |
> + 
> --------------------------------------------------------------------------
> | File /media/data/render/blender/source/blender/python/api2_2x/doc/
> | Texture.py, line 440, in Texture.Texture.setImageFlags
> |   Warning: u'type' expected a single argument
> |
> Warning: Failed identifier crossreference targets:
>         - Constraint.Settings
>               (from Constraint.Constraint.__getitem__)
>               (from Constraint.Constraint.__setitem__)
>         - Type
>               (from Constraint.Constraint.type)
>               (from Constraint.Constraints.append)
> _______________________________________________
> Bf-python mailing list
> Bf-python at blender.org
> http://lists.blender.org/mailman/listinfo/bf-python




More information about the Bf-python mailing list