[ovs-dev] [python idl 12/16] ovs.ovsuuid: Get rid of ovs.ovsuuid.UUID class.
Ethan Jackson
ethan at nicira.com
Mon Sep 19 18:13:52 PDT 2011
The code generally looks good.
Please use two newlines between top level definitions.
> +def to_c_assignment(uuid_, var):
> + """Returns an array of strings, each of which contain a C statement. The
> + statements assign 'uuid_' to a "struct uuid" as defined in Open vSwitch
> + lib/uuid.h."""
I think we need to decide on an OVS style for python docstring
comments. I've looked at both the google style and this one:
http://www.python.org/dev/peps/pep-0257/
I do like the following suggestion that both of them recommend: The
first line of a function docstring should be a short sentence,
followed by a more detailed paragraph separated by a newline. Pep 257
says that this helps automatic indexing tools. I'm not sure we want
to get into prescribing exactly what should be documented and how.
Since we don't have a style, the current code is fine. Just curious
if you have an opinion on this subject.
Ethan
More information about the dev
mailing list