Skip to content

Generated documentation of type aliases are included in unrelated modules #2132

@guillaumekln

Description

@guillaumekln

For example, the documentation of TensorLike is located in tfa.image.color_ops:

https://www.tensorflow.org/addons/api_docs/python/tfa/image/color_ops/TensorLike

Presumably, the system selects the module where the symbol was first found. This is not a big issue but it produces strange and unexpected documentation for type annotations, see for example:

https://www.tensorflow.org/addons/api_docs/python/tfa/seq2seq/LuongAttention

I see 2 possible solutions:

  1. Hide non public symbols in the generated documentation
  2. Properly export type aliases in a public module

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions