diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2016-05-15 07:35:06 +0200 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2016-05-15 07:35:06 +0200 |
| commit | fd4539715da589df5a81b333e71875289687922d (patch) | |
| tree | 68d3f3882680b1f6da370d3367286e72923f2c66 /docs/ext/docstrings.py | |
| parent | 417d27cf7c9569d5057dcced5481a6b9c8dfde2a (diff) | |
| download | gitlab-fd4539715da589df5a81b333e71875289687922d.tar.gz | |
Manage optional parameters for list() and get()
* List these elements in the API doc
* Implement for License objects
Diffstat (limited to 'docs/ext/docstrings.py')
| -rw-r--r-- | docs/ext/docstrings.py | 28 |
1 files changed, 19 insertions, 9 deletions
diff --git a/docs/ext/docstrings.py b/docs/ext/docstrings.py index 4724fc5..4520e43 100644 --- a/docs/ext/docstrings.py +++ b/docs/ext/docstrings.py @@ -30,17 +30,26 @@ def _process_docstring(app, what, name, obj, options, lines): class GitlabDocstring(GoogleDocstring): def _build_doc(self): cls = self._obj.obj_cls + opt_get_list = cls.optionalGetAttrs + opt_list_list = cls.optionalListAttrs md_create_list = list(itertools.chain(cls.requiredUrlAttrs, cls.requiredCreateAttrs)) opt_create_list = cls.optionalCreateAttrs + opt_get_keys = "None" + if opt_get_list: + opt_get_keys = ", ".join(['``%s``' % i for i in opt_get_list]) + + opt_list_keys = "None" + if opt_list_list: + opt_list_keys = ", ".join(['``%s``' % i for i in opt_list_list]) + md_create_keys = opt_create_keys = "None" if md_create_list: - md_create_keys = "%s" % ", ".join(['``%s``' % i for i in - md_create_list]) + md_create_keys = ", ".join(['``%s``' % i for i in md_create_list]) if opt_create_list: - opt_create_keys = "%s" % ", ".join(['``%s``' % i for i in - opt_create_list]) + opt_create_keys = ", ".join(['``%s``' % i for i in + opt_create_list]) md_update_list = list(itertools.chain(cls.requiredUrlAttrs, cls.requiredUpdateAttrs)) @@ -48,11 +57,10 @@ class GitlabDocstring(GoogleDocstring): md_update_keys = opt_update_keys = "None" if md_update_list: - md_update_keys = "%s" % ", ".join(['``%s``' % i for i in - md_update_list]) + md_update_keys = ", ".join(['``%s``' % i for i in md_update_list]) if opt_update_list: - opt_update_keys = "%s" % ", ".join(['``%s``' % i for i in - opt_update_list]) + opt_update_keys = ", ".join(['``%s``' % i for i in + opt_update_list]) tmpl_file = os.path.join(os.path.dirname(__file__), 'template.j2') with open(tmpl_file) as fd: @@ -62,7 +70,9 @@ class GitlabDocstring(GoogleDocstring): md_create_keys=md_create_keys, opt_create_keys=opt_create_keys, md_update_keys=md_update_keys, - opt_update_keys=opt_update_keys) + opt_update_keys=opt_update_keys, + opt_get_keys=opt_get_keys, + opt_list_keys=opt_list_keys) return output.split('\n') |