diff options
| author |  Mark Daoust <markdaoust@google.com> | 2017-10-27 17:47:54 -0700 |
|---|---|---|
| committer |  TensorFlower Gardener <gardener@tensorflow.org> | 2017-10-27 17:51:09 -0700 |
| commit | 729db035e7aaa8811dccff154dc582fab12ccee3 (patch) | |
| tree | aaf3c64f0e79a9aecd2f000174201fdd0a6eff63 /tensorflow/tools/docs | |
| parent | ca56fa49a7755ba2bbd3f586dbaaaefe9e16327d (diff) | |
Allow compatibility notes in class, property and module doc-strings
PiperOrigin-RevId: 173739674
Diffstat (limited to 'tensorflow/tools/docs')
| -rw-r--r-- | tensorflow/tools/docs/pretty_docs.py | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/tensorflow/tools/docs/pretty_docs.py b/tensorflow/tools/docs/pretty_docs.py index 92f50189dd..c033c16ae9 100644 --- a/tensorflow/tools/docs/pretty_docs.py +++ b/tensorflow/tools/docs/pretty_docs.py @@ -117,7 +117,8 @@ def _build_class_page(page_info): parts.append(page_info.guides) parts.append(page_info.doc.docstring) parts.append(_build_function_details(page_info.doc.function_details)) - assert not page_info.doc.compatibility + parts.append(_build_compatibility(page_info.doc.compatibility)) + parts.append('\n\n') if page_info.classes: @@ -139,7 +140,8 @@ def _build_class_page(page_info): parts.append(prop_info.doc.docstring) parts.append(_build_function_details(prop_info.doc.function_details)) - assert not prop_info.doc.compatibility + parts.append(_build_compatibility(prop_info.doc.compatibility)) + parts.append('\n\n') parts.append('\n\n') @@ -206,6 +208,8 @@ def _build_module_page(page_info): parts.append(str(page_info.defined_in)) parts.append(page_info.doc.docstring) + parts.append(_build_compatibility(page_info.doc.compatibility)) + parts.append('\n\n') if page_info.modules: |