On Wed, 2013-04-03 at 15:18 -0700, Brian C. Lane wrote:
On Wed, Apr 03, 2013 at 04:39:00PM -0400, Chris Lumens wrote:
> > +def dbus_call_safe_sync(service, obj_path, iface, method, args,
> > + connection=None):
> > + """
> > + Safely all a given method on a given object of a given service over DBus
>
> Typo - should be "call", not "all".
>
> > + @param service: DBus service to use
> > + @type service: str
> > + @param obj_path: object path of the object to call method on
> > + @type obj_path: str
> > + @param iface: interface to use
> > + @type iface: str
> > + @param method: name of the method to call
> > + @type method: str
> > + @param args: arguments to pass to the method
> > + @type args: GVariant
> > + @param connection: connection to use (if None, a new connection is
> > + established)
> > + @type connection: Gio.DBusConnection
> > + @return: unpacked value returned by the method
> > + @rtype: tuple with elements that depend on the method
> > + @raise DBusCallError: if some DBus related error appears
> > +
> > + """
>
> Just curious - what's this new style of docstrings you guys seem to
> like so much?
I was going to ask about that as well. My understanding was that Sphinx
can use either the @param ...: style or :param ...: style, but that the
latter is more popular so that's what I've been trying to add to my new
code.
I'm not sure Sphinx understands this old format. I'll change it to
the
new one. Maybe we should change it in many places like keyboard.py,
localization.py and so on?
--
Vratislav Podzimek
Anaconda Rider | Red Hat, Inc. | Brno - Czech Republic