experiments/STT-tensorflow
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Allow compatibility notes in class, property and module doc-strings

Browse Source 
PiperOrigin-RevId: 173739674
This commit is contained in:
Mark Daoust 2017-10-27 17:47:54 -07:00 committed by TensorFlower Gardener
parent ca56fa49a7
commit 729db035e7
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
tensorflow/tools/docs/pretty_docs.py
View File

@ -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: