[Pulp-list] Friendly Reminder

[Jay Dobies]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 12/07/2010 09:38 AM, Cliff Perry wrote:
> Jay Dobies wrote:
> When adding a timeout parameter to a method call, don't forget to add
> the epydocs for it and be sure to add the units too. Especially given
> that it may not just be the difference between seconds and milliseconds,
> but the parameter may be a timedelta instead of a number entirely.
> 
>> I admit ignorance - but wouldn't it be better to have all timeouts
>> consistent when/where possible for ease of code maintenance and
>> usability in general of pulp by end users?

End users is kinda another story. You're right, but this was a case of
an internal method that didn't have the code comments.

Your concept is sound and applies to a bunch of things besides timeouts.
But that doesn't necessarily mean it's achieved in all cases  :)



- -- 
Jay Dobies
RHCE# 805008743336126
Freenode: jdob
http://pulpproject.org
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.14 (GNU/Linux)
Comment: Using GnuPG with Fedora - http://enigmail.mozdev.org/

iQEcBAEBAgAGBQJM/kkCAAoJEOMmcTqOSQHCOIIIAJpykOIU505aOgJicaFwF8pg
wT0ASpzRFMdwtQXTU8qzdjgOqt+Dyv9ND/Zbvlpf7v4gd2A68oBuStzqvEZWVCmx
/+OFIeqG6v8Ywlf97rxkVfoFRl1uUVkNwYVlRGtOAnGPwUh1yUZObGNyAlm9U0rM
dL9Op3vi1YzcqsKeXWWAeJOBqihUMBCoh5XV3B/VWltDtYVnrCVzb+WCuEdQVLVj
YSHoQYa7Fy+2qzivcoSqte7VYQ6oVfnTWdgCTu4aKK+TW4U8SN/kXnkvGIz5YA2G
J6RFfjy9g91yFTOJzWsZFEt7TBw5nh7OANb01ATOseqZFlLdmC5e9ZiSEjRrweM=
=UhiQ
-----END PGP SIGNATURE-----