From 8997d88bf97d1784706becbf8e9dc74e4656e311 Mon Sep 17 00:00:00 2001 From: Justus Winter Date: Tue, 14 Jun 2016 13:28:37 +0200 Subject: python: Improve autmatically generated docstrings. * lang/python/gpgme.i: Add comment. * lang/python/pyme/core.py (__getattr__): Rewrite automatically generated doctrings for the wrapper methods. Signed-off-by: Justus Winter --- lang/python/gpgme.i | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) (limited to 'lang/python/gpgme.i') diff --git a/lang/python/gpgme.i b/lang/python/gpgme.i index c6ddbb40..8dbb0c2c 100644 --- a/lang/python/gpgme.i +++ b/lang/python/gpgme.i @@ -21,11 +21,21 @@ %include "cpointer.i" %include "cstring.i" -// Generate doc strings for all methods. +/* Generate doc strings for all methods. + + This will generate docstrings of the form + + gpgme_op_encrypt(ctx, recp, flags, plain, cipher) -> gpgme_error_t + + which we transform into + + ctx.op_encrypt(recp, flags, plain, cipher) -> gpgme_error_t + + for automagically wrapped functions. */ %feature("autodoc", "0"); -/* Allow use of Unicode objects, bytes, and None for strings. */ +/* Allow use of Unicode objects, bytes, and None for strings. */ %typemap(in) const char * { if ($input == Py_None) $1 = NULL; -- cgit v1.2.3