[BEAM-14401] Incomplete documentation rendering for classes decorated by deprecated or experimental

• Type: Bug
• Status: Open
• Priority: P2
• Resolution: Unresolved
• Component/s: io-py-files, website
• Assignee: Unassigned
• Reporter: Yi Hu
• Created: 03/May/22 17:19
• Updated: 05/Jun/22 00:19

Description

For example in https://beam.apache.org/releases/pydoc/current/apache_beam.io.fileio.html , there is a statement about "WriteToFiles", but there is not documentation of this class. Taking a glance at the source code, there are class docstring and constructor docstring as well.

Also in this module, the class docstring of MatchContinuously is rendered, but not its _init.doc_ . For classes not decorated by deprecated or experimental, the documentation generation looks fine.

 

The issue seems existing from very early versions (at least v2.14.0 where WriteToFiles is introduced)