[
https://issues.apache.org/jira/browse/BEAM-8996?focusedWorklogId=365449&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-365449
]
ASF GitHub Bot logged work on BEAM-8996:
----------------------------------------
Author: ASF GitHub Bot
Created on: 02/Jan/20 18:40
Start Date: 02/Jan/20 18:40
Worklog Time Spent: 10m
Work Description: tweise commented on issue #10424: [BEAM-8996]
Auto-generate pipeline options documentation for FlinkRunner
URL: https://github.com/apache/beam/pull/10424#issuecomment-570300807
@mxm thanks for working in this, it is a good improvement.
However, regarding the merge if this PR, I would prefer more time is given
to allow for comments and consideration of comments. We should wait for an
approval, not just assume everything was reviewed and addressed.
There is no reason to rush this type of change.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 365449)
Time Spent: 4h (was: 3h 50m)
> Auto-generate pipeline options documentation for FlinkRunner
> ------------------------------------------------------------
>
> Key: BEAM-8996
> URL: https://issues.apache.org/jira/browse/BEAM-8996
> Project: Beam
> Issue Type: Improvement
> Components: runner-flink
> Reporter: Maximilian Michels
> Assignee: Maximilian Michels
> Priority: Major
> Fix For: 2.19.0
>
> Time Spent: 4h
> Remaining Estimate: 0h
>
> The documentation on the pipeline options on the [runner
> page|https://beam.apache.org/documentation/runners/flink/] easily becomes
> outdated. In order for them to stay up to date, we should auto-generate the
> documentation from the {{FlinkPipelineOptions}} class. This should be done
> for both Java and Python.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
