launchpad-reviewers team mailing list archive

[Richard Harding <rick.harding@xxxxxxxxxxxxx>]

Review: Needs Fixing

Thanks for updating the comments JC. In digging at this I didn't initially get the 'args' business. I had to look at how things fit together to understand you're expected to toss a property .args onto the function you intend to call on the LPClient method you want to actually call since it's wrapping the calls to the _call method itself.

So really there are two different 'args' in use here. There's the arguments sent into the called method arguments->args into _call().

lpclient_instance.get(arg1, arg2)

and the args.callee.args which are assigned and contain the callbacks and info such as fail/etc. This is required for the method to work, but it's not directly passed into play.

The comments didn't really help clear that up to me until I ran through examples/source. 

So to help in clarity, I'd think it'd be good to have a small "Usage: " block that walks through those on the LPClient class itself and note/distriguish both args usages especially since the non-obvious one (lpclient_instance.get.args) is required for things to work.

-- 
https://code.launchpad.net/~jcsackett/launchpad/helpers-docs/+merge/117457
Your team Launchpad code reviewers is subscribed to branch lp:launchpad.