oship-dev team mailing list archive

[Diego Manhães Pinheiro <me@xxxxxxxxxxxxxx>]

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

Hi all,


I'd like report you about the new code conventions defined on the last
meeting:

- - All codes will be formatted on the PEP8 convention. So, I will be glad
if starting now, all code sent the launchpad was on this code
convention. Refreshing the memory : variables, instance_variables,
function and class method names must be on lower case separated by
underscores. I hope very soon all code will be converted from the actual
convention (CamelCase) to the PEP8.
- - Use doctest wasn't helping anybody on understand how the classes
works. Thus this point forward, all tests must use unittest instead of
doctests. Athough doctest is a excelent tool to create good explanation
to how the code works, it neither works with python coverage tools nor
create value, because I hardly ever have seen it complement the
documentation found on the openEHR specification documents. Using
unittest module helps a lot new develpers understand how the classes
works, because it based on the xUnit tools family. It also helps to
define a more close coverage on the object messages, providing code
reuse on the test layer.


I wish everybody that have been working with code stay on alert about
these two items.


My regards
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (Darwin)

iQEcBAEBAgAGBQJM3Jy1AAoJEEfarWn4YOc84n8IAJkcez9+s3utLH00varnu+dy
BAb0Q2DPPQkAYjzFDn1ilKYlWU/brWm88cSJA0qdSdrTYEHsmPz3ahcXU5PJ/sCY
T9z03Dcik31MTcccUhzYOSGD6RzcCE7QUFEoH59BYX6+t/l92/WltzK7Q5URRYZS
CQKlfAOaGA0/pT9mI8oUt1UWX8/qzTjVtk0EKSHWk3INjPS0+BI7i7jKstGuHNvg
3vA+nim3IJnt/P8kg/+4n5qPO3Dlo9g+8vw7Fs+9KZMa/mG8xyfPN+xhtRYRahtS
BCG8Mpby46MqPD9Wt/hgsRvCc4taRasqjzDdaE4Hx0h6kKajNmnkXdJQdtb5kbU=
=LWpK
-----END PGP SIGNATURE-----