From fc4d37062c46886d3bc1fb0b6c3626d779be4ecd Mon Sep 17 00:00:00 2001 From: Ben Reynwar <ben@reynwar.net> Date: Tue, 14 Aug 2012 10:28:23 -0700 Subject: docs: Modified argument formating in python docstrings in grc. --- grc/gui/Actions.py | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) (limited to 'grc/gui/Actions.py') diff --git a/grc/gui/Actions.py b/grc/gui/Actions.py index 4d196477eb..2a8676e9b4 100644 --- a/grc/gui/Actions.py +++ b/grc/gui/Actions.py @@ -33,8 +33,12 @@ def handle_key_press(event): """ Call the action associated with the key press event. Both the key value and the mask must have a match. - @param event a gtk key press event - @return true if handled + + Args: + event: a gtk key press event + + Returns: + true if handled """ _used_mods_mask = reduce(lambda x, y: x | y, [mod_mask for keyval, mod_mask in _actions_keypress_dict], NO_MODS_MASK) #extract the key value and the consumed modifiers @@ -63,8 +67,10 @@ class Action(gtk.Action): def __init__(self, keypresses=(), name=None, label=None, tooltip=None, stock_id=None): """ Create a new Action instance. - @param key_presses a tuple of (keyval1, mod_mask1, keyval2, mod_mask2, ...) - @param the regular gtk.Action parameters (defaults to None) + + Args: + key_presses: a tuple of (keyval1, mod_mask1, keyval2, mod_mask2, ...) + the: regular gtk.Action parameters (defaults to None) """ if name is None: name = label gtk.Action.__init__(self, -- cgit v1.2.3