You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@beam.apache.org by "Valentyn Tymofieiev (Jira)" <ji...@apache.org> on 2022/05/05 15:57:00 UTC
[jira] [Comment Edited] (BEAM-14401) Incomplete documentation rendering for classes decorated by deprecated or experimental
[ https://issues.apache.org/jira/browse/BEAM-14401?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17532378#comment-17532378 ]
Valentyn Tymofieiev edited comment on BEAM-14401 at 5/5/22 3:56 PM:
--------------------------------------------------------------------
We do have several features that were labelled as experimental a while ago, but de-facto are no longer experimental. It would make sense to add feature request to add proper documentation where missing, and consider removing experimental annotations where applicable. It would be easier to file issues for a defined scope so that we can divide and conquer. How about we repurpose this issue to track improvements to WriteToFiles?
was (Author: tvalentyn):
We do have several features that were labelled as experimental a while ago, but de-facto are no longer experimental. It would make sense to add feature request to add proper documentation where missing, and consider removing experimental annotations where applicable. It would be easier to file issues for a defined scope so that we can divide in conquer. How about we repurpose this issue to track improvements to WriteToFiles?
> Incomplete documentation rendering for classes decorated by deprecated or experimental
> ---------------------------------------------------------------------------------------
>
> Key: BEAM-14401
> URL: https://issues.apache.org/jira/browse/BEAM-14401
> Project: Beam
> Issue Type: Bug
> Components: io-py-files, website
> Reporter: Yi Hu
> Priority: P2
>
> 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)