aboutsummaryrefslogtreecommitdiffhomepage
path: root/tensorflow/tools/docs
diff options
context:
space:
mode:
authorGravatar Mark Daoust <markdaoust@google.com>2018-02-01 10:43:29 -0800
committerGravatar TensorFlower Gardener <gardener@tensorflow.org>2018-02-01 17:09:08 -0800
commita1a34b1440c4c4792f945275529e6c5b3c7aa2ca (patch)
tree41dfd81c061af7eea811ee3ef0cb0a41a4f08893 /tensorflow/tools/docs
parent69655f34611747e51fc2644d1888301ecfcc4c96 (diff)
Add function paths to their signatures.
fixes #16167 PiperOrigin-RevId: 184160925
Diffstat (limited to 'tensorflow/tools/docs')
-rw-r--r--tensorflow/tools/docs/pretty_docs.py14
1 files changed, 9 insertions, 5 deletions
diff --git a/tensorflow/tools/docs/pretty_docs.py b/tensorflow/tools/docs/pretty_docs.py
index c033c16ae9..ac04f566d0 100644
--- a/tensorflow/tools/docs/pretty_docs.py
+++ b/tensorflow/tools/docs/pretty_docs.py
@@ -162,7 +162,7 @@ def _build_class_page(page_info):
parts.append(h3.format(**method_info.__dict__))
if method_info.signature is not None:
- parts.append(_build_signature(method_info))
+ parts.append(_build_signature(method_info, use_full_name=False))
parts.append(method_info.doc.docstring)
parts.append(_build_function_details(method_info.doc.function_details))
@@ -259,14 +259,14 @@ def _build_module_page(page_info):
return ''.join(parts)
-def _build_signature(obj_info):
+def _build_signature(obj_info, use_full_name=True):
"""Returns a md code block showing the function signature."""
# Special case tf.range, since it has an optional first argument
if obj_info.full_name == 'tf.range':
return (
'``` python\n'
- "range(limit, delta=1, dtype=None, name='range')\n"
- "range(start, limit, delta=1, dtype=None, name='range')\n"
+ "tf.range(limit, delta=1, dtype=None, name='range')\n"
+ "tf.range(start, limit, delta=1, dtype=None, name='range')\n"
'```\n\n')
parts = ['``` python']
@@ -281,7 +281,11 @@ def _build_signature(obj_info):
sig = ',\n'.join(' %s' % sig_item for sig_item in obj_info.signature)
sig = '\n'+sig+'\n'
- parts.append(signature_template.format(name=obj_info.short_name, sig=sig))
+ if use_full_name:
+ obj_name = obj_info.full_name
+ else:
+ obj_name = obj_info.short_name
+ parts.append(signature_template.format(name=obj_name, sig=sig))
parts.append('```\n\n')
return '\n'.join(parts)