[ovs-dev] [ovsdb-idlc 2/4] ovsdb-idlc: Generate comments for "*_set" functions.
Justin Pettit
jpettit at nicira.com
Thu Mar 5 02:05:02 UTC 2015
On Wed, Mar 4, 2015 at 1:40 PM, Ben Pfaff <blp at nicira.com> wrote:
> On Wed, Mar 04, 2015 at 11:25:51AM -0800, Justin Pettit wrote:
> > Signed-off-by: Justin Pettit <jpettit at nicira.com>
>
> "git" says:
>
> Applying: ovsdb-idlc: Generate comments for "*_set" functions.
> /home/blp/ovs/.git/rebase-apply/patch:81: trailing whitespace.
> comment += """.
> warning: 1 line adds whitespace errors.
>
Fixed.
> If you wanted the comments to be even more helpful, you could add some
> elaborations:
>
> * For optional pointers, something like "If 'columnName' is
> null, the column will be the empty set, otherwise it will
> contain the specified value."
>
> * For other optional values, something like "'sizeArg' may be
> 0 or 1; if it is 0, then 'pointerArg' may be NULL."
>
> * For keys or values with constraints, describe them (see
> Type.constraintsToEnglish in types.py).
>
It's a good suggestion. I'm about to send out v2.
--Justin
More information about the dev
mailing list