Yi Hu created BEAM-14401:
----------------------------

             Summary: Incomplete documentation rendering for classes decorated 
by deprecated experimental 
                 Key: BEAM-14401
                 URL: https://issues.apache.org/jira/browse/BEAM-14401
             Project: Beam
          Issue Type: Bug
          Components: sdk-py-core, website
            Reporter: Yi Hu


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)



--
This message was sent by Atlassian Jira
(v8.20.7#820007)

Reply via email to