Test headers.

PiperOrigin-RevId: 358035270

Author: MarkDaoust

tools/tensorflow_docs/api_generator/generate_lib.py

@@ -411,6 +411,26 @@ def generate(self) -> Dict[str, Any]:
     return {'toc': toc}
 
 
+def _get_headers(page_info: parser.PageInfo, search_hints: bool) -> List[str]:
+  """Returns the list of header lines for this page."""
+  hidden = doc_controls.should_hide_from_search(page_info.py_object)
+  brief_no_backticks = page_info.doc.brief.replace('`', '').strip()
+  headers = []
+  if brief_no_backticks:
+    headers.append(f'description: {brief_no_backticks}')
+
+  # It's easier to read if there's a blank line after the `name:value` headers.
+  if search_hints and not hidden:
+    if headers:
+      headers.append('')
+    headers.append(page_info.get_metadata_html())
+  else:
+    headers.append('robots: noindex')
+    headers.append('')
+
+  return headers
+
+
 def write_docs(
     *,
     output_dir: Union[str, pathlib.Path],
@@ -526,22 +546,12 @@ def write_docs(
       continue
 
     path = output_dir / parser.documentation_path(full_name)
+
+    content = _get_headers(page_info, search_hints)
+    content.append(pretty_docs.build_md_page(page_info))
+    text = '\n'.join(content)
     try:
       path.parent.mkdir(exist_ok=True, parents=True)
-      # This function returns unicode in PY3.
-      hidden = doc_controls.should_hide_from_search(page_info.py_object)
-      brief_no_backticks = page_info.doc.brief.replace('`', '').strip()
-      content = []
-      if brief_no_backticks:
-        content.append(f'description: {brief_no_backticks}\n')
-
-      if search_hints and not hidden:
-        content.append(page_info.get_metadata_html())
-      else:
-        content.append('robots: noindex\n')
-
-      content.append(pretty_docs.build_md_page(page_info))
-      text = '\n'.join(content)
       path.write_text(text, encoding='utf-8')
     except OSError:
       raise OSError('Cannot write documentation for '

tools/tensorflow_docs/api_generator/generate_lib_test.py

@@ -19,10 +19,12 @@
 import pathlib
 import sys
 import tempfile
+import textwrap
 
 from absl import flags
 from absl.testing import absltest
 
+from tensorflow_docs.api_generator import doc_controls
 from tensorflow_docs.api_generator import generate_lib
 from tensorflow_docs.api_generator import parser
 
@@ -244,6 +246,60 @@ def test_replace_refes(self):
       with open(os.path.join(test_out_dir, 'b/OWNERS')) as f:
         content = f.read()
 
+  def _get_test_page_info(self):
+    page_info = parser.FunctionPageInfo(
+        full_name='abc', py_object=test_function)
+    docstring_info = parser._DocstringInfo(
+        brief='hello `tensorflow`',
+        docstring_parts=['line1', 'line2'],
+        compatibility={})
+    page_info.set_doc(docstring_info)
+    return page_info
+
+  def test_get_headers_global_hints(self):
+    page_info = self._get_test_page_info()
+    result = '\n'.join(generate_lib._get_headers(page_info, search_hints=True))
+
+    expected = textwrap.dedent("""\
+      description: hello tensorflow
+
+      <div itemscope itemtype="http://developers.google.com/ReferenceObject">
+      <meta itemprop="name" content="abc" />
+      <meta itemprop="path" content="Stable" />
+      </div>
+      """)
+
+    self.assertEqual(expected, result)
+
+  def test_get_headers_global_no_hints(self):
+    page_info = self._get_test_page_info()
+    result = '\n'.join(generate_lib._get_headers(page_info, search_hints=False))
+
+    expected = textwrap.dedent("""\
+      description: hello tensorflow
+      robots: noindex
+      """)
+
+    self.assertEqual(expected, result)
+
+  def test_get_headers_local_no_hints(self):
+    page_info = self._get_test_page_info()
+
+    @doc_controls.hide_from_search
+    def py_object():
+      pass
+
+    page_info.py_object = py_object
+
+    result = '\n'.join(generate_lib._get_headers(page_info, search_hints=True))
+
+    expected = textwrap.dedent("""\
+      description: hello tensorflow
+      robots: noindex
+      """)
+
+    self.assertEqual(expected, result)
+
 
 if __name__ == '__main__':
   absltest.main()