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/Dialogs.py | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) (limited to 'grc/gui/Dialogs.py') diff --git a/grc/gui/Dialogs.py b/grc/gui/Dialogs.py index 473c796aff..df424750b9 100644 --- a/grc/gui/Dialogs.py +++ b/grc/gui/Dialogs.py @@ -28,7 +28,9 @@ class TextDisplay(gtk.TextView): def __init__(self, text=''): """ TextDisplay constructor. - @param text the text to display (string) + + Args: + text: the text to display (string) """ text_buffer = gtk.TextBuffer() text_buffer.set_text(text) @@ -42,12 +44,18 @@ class TextDisplay(gtk.TextView): def MessageDialogHelper(type, buttons, title=None, markup=None): """ Create a modal message dialog and run it. - @param type the type of message: gtk.MESSAGE_INFO, gtk.MESSAGE_WARNING, gtk.MESSAGE_QUESTION or gtk.MESSAGE_ERROR - @param buttons the predefined set of buttons to use: + + Args: + type: the type of message: gtk.MESSAGE_INFO, gtk.MESSAGE_WARNING, gtk.MESSAGE_QUESTION or gtk.MESSAGE_ERROR + buttons: the predefined set of buttons to use: gtk.BUTTONS_NONE, gtk.BUTTONS_OK, gtk.BUTTONS_CLOSE, gtk.BUTTONS_CANCEL, gtk.BUTTONS_YES_NO, gtk.BUTTONS_OK_CANCEL - @param tittle the title of the window (string) - @param markup the message text with pango markup - @return the gtk response from run() + + Args: + tittle: the title of the window (string) + markup: the message text with pango markup + + Returns: + the gtk response from run() """ message_dialog = gtk.MessageDialog(None, gtk.DIALOG_MODAL, type, buttons) if title: message_dialog.set_title(title) -- cgit v1.2.3