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/python/extract_docs.py | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) (limited to 'grc/python/extract_docs.py') diff --git a/grc/python/extract_docs.py b/grc/python/extract_docs.py index a7e945c373..8c151b6e1a 100644 --- a/grc/python/extract_docs.py +++ b/grc/python/extract_docs.py @@ -23,8 +23,12 @@ def _extract(key): """ Extract the documentation from the python __doc__ strings. If multiple modules match, combine the docs. - @param key the block key - @return a string with documentation + + Args: + key: the block key + + Returns: + a string with documentation """ #extract matches try: @@ -48,8 +52,12 @@ _docs_cache = dict() def extract(key): """ Call the private extract and cache the result. - @param key the block key - @return a string with documentation + + Args: + key: the block key + + Returns: + a string with documentation """ if not _docs_cache.has_key(key): _docs_cache[key] = _extract(key) -- cgit v1.2.3