tfdocs.doc_controls.doc_private

A decorator: Generates docs for private methods/functions.

tfdocs.doc_controls.doc_private(
    obj: tfdocs.doc_controls.T
) -> tfdocs.doc_controls.T

For example:

class Try:

  @doc_controls.doc_private
  def _private(self):
    ...

As a rule of thumb, private(beginning with _) methods/functions are not documented.

This decorator allows to force document a private method/function.

obj The class-attribute to hide from the generated docs.

obj