diff options
| author | Johnathan Corgan <jcorgan@corganenterprises.com> | 2012-08-28 12:52:09 -0700 |
|---|---|---|
| committer | Johnathan Corgan <jcorgan@corganenterprises.com> | 2012-08-28 12:52:09 -0700 |
| commit | 5892c29ee0509ff8aa226f14da524f7ec30f9654 (patch) | |
| tree | 759624a4c9f9b5d6c2e2da13906be99aebf25152 /grc/python/extract_docs.py | |
| parent | 7adff515181de5cfbd7392d934cac9083a8a6a58 (diff) | |
| parent | fc4d37062c46886d3bc1fb0b6c3626d779be4ecd (diff) | |
Merge remote branch 'reynwar/comments_next' into next
Conflicts:
gr-digital/include/digital_constellation.h
gr-digital/python/bpsk.py
gr-digital/python/qpsk.py
Diffstat (limited to 'grc/python/extract_docs.py')
| -rw-r--r-- | grc/python/extract_docs.py | 16 |
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) |