Re: [pygame] blit anomalies in pygame 1.8.1release (2)

["claudio canepa" <ccanepacc@xxxxxxxxx>]

Lenard wrote:

[...]
The documentation is vague on this point. The argument names are descriptive only in most cases. The actual arguments are strictly positional. While technically the argument signature for Surface.blit is (*args), this is also misleading as blit has only fixed aguments. Such documenting practices also show up in Python builtins:
[...]
/end quote
 

Lenard, thanks for the extensive explanation about documentation.

Certainly this style for documentation is more readable that the syntax correct:

.   pygame.Surface( source, dest [, area [, special_flags]] )

Unambiguous alternative can be:

.   pygame.Surface( source, dest, area <- None , special_flags <- 0 )

But probably a brief 'conventions' section in the documentation can be enought (and wellcomed).

 

--

claxo