Update docsting for function _underscore().

2013-03-07 04:07:26 +00:00 · 2013-03-07 04:07:26 +00:00 · 1144d79a25
parent 7008b10f69
commit 1144d79a25
1 changed files with 4 additions and 0 deletions
--- a/gnupg.py
+++ b/gnupg.py
@ -575,7 +575,11 @@ def _underscore(input, remove_prefix=False):
    Change hyphens to underscores so that GPG option names can be easily
    tranlated to object attributes.

+    @type input: C{str}
    @param input: The input intended for the gnupg process.
+
+    @type remove_prefix: C{bool}
+    @param remove_prefix: If True, strip leading hyphens from the input.
    """
    if not remove_prefix:
        return input.replace('-', '_')