summaryrefslogtreecommitdiff
path: root/grc/python/extract_docs.py
diff options
context:
space:
mode:
Diffstat (limited to 'grc/python/extract_docs.py')
-rw-r--r--grc/python/extract_docs.py16
1 files changed, 12 insertions, 4 deletions
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)