RSS LJ

August 14, 2008

Documentation (, )

by fluffy at 5:33 PM
Quick poll: when you see this documentation in a cross-platform image-handling API:
width: Specifies the width of the image. All implementations support images that are at least 64 pixels wide.
what do you think that means in terms of valid parameters to be passed into the width parameter?

Comments

#11198 08/14/2008 06:42 pm
The function will always work if width >= 64. It might work if width < 64, but that's platform-dependent.
#11199 08/14/2008 06:57 pm
Yeah I know right?

Followup question: what if the only relevant documented error return is

INVALID_VALUE is generated if width or height is less than 0 or greater than MAX_TEXTURE_SIZE
#11200 08/14/2008 08:49 pm
I read that as meaning that the implementation will always support at least width ≤ 64.
#11201 08/14/2008 08:52 pm
zetawoof apparently lives on the same planet as whoever wrote that documentation.
#11211 08/19/2008 11:11 am
I'm with Paul and fluffy on this one... if it means what Zeta says it's terrible English!
-bill