You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2020/02/07 04:45:39 UTC
[GitHub] [flink] dianfu opened a new pull request #11035:
[FLINK-15902][python][doc] Improve the Python API doc adding the version an
API introduced
dianfu opened a new pull request #11035: [FLINK-15902][python][doc] Improve the Python API doc adding the version an API introduced
URL: https://github.com/apache/flink/pull/11035
## What is the purpose of the change
*Currently it's not possible to know in which version a Python API is added. This information is very useful for users and this PR will address this problem.*
## Brief change log
- *Add a since decorator*
- *Add since decorator for the the APIs introduced in 1.10*
## Verifying this change
This change is a documentation work without any test coverage and have checked the Python doc manually.
## Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): (no)
- The public API, i.e., is any changed class annotated with `@Public(Evolving)`: (no)
- The serializers: (no)
- The runtime per-record code paths (performance sensitive): (no)
- Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Yarn/Mesos, ZooKeeper: (no)
- The S3 file system connector: (no)
## Documentation
- Does this pull request introduce a new feature? (no)
- If yes, how is the feature documented? (not applicable)
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [flink] dianfu commented on issue #11035:
[FLINK-15902][python][doc] Improve the Python API doc adding the version an
API introduced
Posted by GitBox <gi...@apache.org>.
dianfu commented on issue #11035: [FLINK-15902][python][doc] Improve the Python API doc adding the version an API introduced
URL: https://github.com/apache/flink/pull/11035#issuecomment-583297005
Merged as the [travis](https://travis-ci.org/dianfu/flink/jobs/647190651?utm_medium=notification&utm_source=email) has passed.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [flink] flinkbot edited a comment on issue #11035:
[FLINK-15902][python][doc] Improve the Python API doc adding the version an
API introduced
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on issue #11035: [FLINK-15902][python][doc] Improve the Python API doc adding the version an API introduced
URL: https://github.com/apache/flink/pull/11035#issuecomment-583237005
<!--
Meta data
Hash:87d40c562765eb73acfc370039a590a2c98c5bd0 Status:PENDING URL:https://travis-ci.com/flink-ci/flink/builds/147870982 TriggerType:PUSH TriggerID:87d40c562765eb73acfc370039a590a2c98c5bd0
Hash:87d40c562765eb73acfc370039a590a2c98c5bd0 Status:PENDING URL:https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4928 TriggerType:PUSH TriggerID:87d40c562765eb73acfc370039a590a2c98c5bd0
Hash:97fa61565812a6f2123c9c1cd87e9507d2633dfa Status:UNKNOWN URL:TBD TriggerType:PUSH TriggerID:97fa61565812a6f2123c9c1cd87e9507d2633dfa
-->
## CI report:
* 87d40c562765eb73acfc370039a590a2c98c5bd0 Travis: [PENDING](https://travis-ci.com/flink-ci/flink/builds/147870982) Azure: [PENDING](https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4928)
* 97fa61565812a6f2123c9c1cd87e9507d2633dfa UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [flink] WeiZhong94 commented on a change in pull request #11035:
[FLINK-15902][python][doc] Improve the Python API doc adding the version an
API introduced
Posted by GitBox <gi...@apache.org>.
WeiZhong94 commented on a change in pull request #11035: [FLINK-15902][python][doc] Improve the Python API doc adding the version an API introduced
URL: https://github.com/apache/flink/pull/11035#discussion_r376219698
##########
File path: flink-python/pyflink/table/table_environment.py
##########
@@ -288,8 +290,11 @@ def insert_into(self, target_path, table):
:param target_path: The path of the registered :class:`~pyflink.table.TableSink` to which
the :class:`~pyflink.table.Table` is written.
:type target_path: str
- :param table: table The Table to write to the sink.
+ :param table: The Table to write to the sink.
:type table: pyflink.table.Table
+
+ .. versionadded:: 1.10.0
Review comment:
Use 'versionchanged' instead?
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [flink] flinkbot edited a comment on issue #11035:
[FLINK-15902][python][doc] Improve the Python API doc adding the version an
API introduced
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on issue #11035: [FLINK-15902][python][doc] Improve the Python API doc adding the version an API introduced
URL: https://github.com/apache/flink/pull/11035#issuecomment-583237005
<!--
Meta data
Hash:87d40c562765eb73acfc370039a590a2c98c5bd0 Status:FAILURE URL:https://travis-ci.com/flink-ci/flink/builds/147870982 TriggerType:PUSH TriggerID:87d40c562765eb73acfc370039a590a2c98c5bd0
Hash:87d40c562765eb73acfc370039a590a2c98c5bd0 Status:SUCCESS URL:https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4928 TriggerType:PUSH TriggerID:87d40c562765eb73acfc370039a590a2c98c5bd0
Hash:97fa61565812a6f2123c9c1cd87e9507d2633dfa Status:FAILURE URL:https://travis-ci.com/flink-ci/flink/builds/147874247 TriggerType:PUSH TriggerID:97fa61565812a6f2123c9c1cd87e9507d2633dfa
Hash:97fa61565812a6f2123c9c1cd87e9507d2633dfa Status:FAILURE URL:https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4929 TriggerType:PUSH TriggerID:97fa61565812a6f2123c9c1cd87e9507d2633dfa
Hash:97fa61565812a6f2123c9c1cd87e9507d2633dfa Status:FAILURE URL:https://travis-ci.com/flink-ci/flink/builds/147874247 TriggerType:MANUAL TriggerID:583260588
Hash:97fa61565812a6f2123c9c1cd87e9507d2633dfa Status:FAILURE URL:https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4929 TriggerType:MANUAL TriggerID:583260652
Hash:97fa61565812a6f2123c9c1cd87e9507d2633dfa Status:FAILURE URL:https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4929 TriggerType:MANUAL TriggerID:583260588
Hash:97fa61565812a6f2123c9c1cd87e9507d2633dfa Status:FAILURE URL:https://travis-ci.com/flink-ci/flink/builds/147874247 TriggerType:MANUAL TriggerID:583260652
-->
## CI report:
* 87d40c562765eb73acfc370039a590a2c98c5bd0 Travis: [FAILURE](https://travis-ci.com/flink-ci/flink/builds/147870982) Azure: [SUCCESS](https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4928)
* 97fa61565812a6f2123c9c1cd87e9507d2633dfa Travis: [FAILURE](https://travis-ci.com/flink-ci/flink/builds/147874247) Azure: [FAILURE](https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4929)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [flink] flinkbot commented on issue #11035:
[FLINK-15902][python][doc] Improve the Python API doc adding the version an
API introduced
Posted by GitBox <gi...@apache.org>.
flinkbot commented on issue #11035: [FLINK-15902][python][doc] Improve the Python API doc adding the version an API introduced
URL: https://github.com/apache/flink/pull/11035#issuecomment-583237005
<!--
Meta data
Hash:87d40c562765eb73acfc370039a590a2c98c5bd0 Status:UNKNOWN URL:TBD TriggerType:PUSH TriggerID:87d40c562765eb73acfc370039a590a2c98c5bd0
-->
## CI report:
* 87d40c562765eb73acfc370039a590a2c98c5bd0 UNKNOWN
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [flink] dianfu commented on issue #11035:
[FLINK-15902][python][doc] Improve the Python API doc adding the version an
API introduced
Posted by GitBox <gi...@apache.org>.
dianfu commented on issue #11035: [FLINK-15902][python][doc] Improve the Python API doc adding the version an API introduced
URL: https://github.com/apache/flink/pull/11035#issuecomment-583246318
@WeiZhong94 Thanks for the review. Good catch and have updated the PR.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [flink] flinkbot commented on issue #11035:
[FLINK-15902][python][doc] Improve the Python API doc adding the version an
API introduced
Posted by GitBox <gi...@apache.org>.
flinkbot commented on issue #11035: [FLINK-15902][python][doc] Improve the Python API doc adding the version an API introduced
URL: https://github.com/apache/flink/pull/11035#issuecomment-583232399
Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.
## Automated Checks
Last check on commit 87d40c562765eb73acfc370039a590a2c98c5bd0 (Fri Feb 07 04:48:09 UTC 2020)
**Warnings:**
* No documentation files were touched! Remember to keep the Flink docs up to date!
<sub>Mention the bot in a comment to re-run the automated checks.</sub>
## Review Progress
* ❓ 1. The [description] looks good.
* ❓ 2. There is [consensus] that the contribution should go into to Flink.
* ❓ 3. Needs [attention] from.
* ❓ 4. The change fits into the overall [architecture].
* ❓ 5. Overall code [quality] is good.
Please see the [Pull Request Review Guide](https://flink.apache.org/contributing/reviewing-prs.html) for a full explanation of the review process.<details>
The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required <summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot approve description` to approve one or more aspects (aspects: `description`, `consensus`, `architecture` and `quality`)
- `@flinkbot approve all` to approve all aspects
- `@flinkbot approve-until architecture` to approve everything until `architecture`
- `@flinkbot attention @username1 [@username2 ..]` to require somebody's attention
- `@flinkbot disapprove architecture` to remove an approval you gave earlier
</details>
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [flink] dianfu commented on issue #11035:
[FLINK-15902][python][doc] Improve the Python API doc adding the version an
API introduced
Posted by GitBox <gi...@apache.org>.
dianfu commented on issue #11035: [FLINK-15902][python][doc] Improve the Python API doc adding the version an API introduced
URL: https://github.com/apache/flink/pull/11035#issuecomment-583260588
@flinkbot run travis
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [flink] WeiZhong94 commented on issue #11035:
[FLINK-15902][python][doc] Improve the Python API doc adding the version an
API introduced
Posted by GitBox <gi...@apache.org>.
WeiZhong94 commented on issue #11035: [FLINK-15902][python][doc] Improve the Python API doc adding the version an API introduced
URL: https://github.com/apache/flink/pull/11035#issuecomment-583258138
@dianfu Thanks for your update! LGTM, +1 to merge.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [flink] dianfu closed pull request #11035:
[FLINK-15902][python][doc] Improve the Python API doc adding the version an
API introduced
Posted by GitBox <gi...@apache.org>.
dianfu closed pull request #11035: [FLINK-15902][python][doc] Improve the Python API doc adding the version an API introduced
URL: https://github.com/apache/flink/pull/11035
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [flink] dianfu commented on issue #11035:
[FLINK-15902][python][doc] Improve the Python API doc adding the version an
API introduced
Posted by GitBox <gi...@apache.org>.
dianfu commented on issue #11035: [FLINK-15902][python][doc] Improve the Python API doc adding the version an API introduced
URL: https://github.com/apache/flink/pull/11035#issuecomment-583259955
@WeiZhong94 Thanks for the review. Will merge the PR once the travis turns green.
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [flink] flinkbot edited a comment on issue #11035:
[FLINK-15902][python][doc] Improve the Python API doc adding the version an
API introduced
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on issue #11035: [FLINK-15902][python][doc] Improve the Python API doc adding the version an API introduced
URL: https://github.com/apache/flink/pull/11035#issuecomment-583237005
<!--
Meta data
Hash:87d40c562765eb73acfc370039a590a2c98c5bd0 Status:FAILURE URL:https://travis-ci.com/flink-ci/flink/builds/147870982 TriggerType:PUSH TriggerID:87d40c562765eb73acfc370039a590a2c98c5bd0
Hash:87d40c562765eb73acfc370039a590a2c98c5bd0 Status:SUCCESS URL:https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4928 TriggerType:PUSH TriggerID:87d40c562765eb73acfc370039a590a2c98c5bd0
Hash:97fa61565812a6f2123c9c1cd87e9507d2633dfa Status:FAILURE URL:https://travis-ci.com/flink-ci/flink/builds/147874247 TriggerType:PUSH TriggerID:97fa61565812a6f2123c9c1cd87e9507d2633dfa
Hash:97fa61565812a6f2123c9c1cd87e9507d2633dfa Status:FAILURE URL:https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4929 TriggerType:PUSH TriggerID:97fa61565812a6f2123c9c1cd87e9507d2633dfa
Hash:97fa61565812a6f2123c9c1cd87e9507d2633dfa Status:PENDING URL:https://travis-ci.com/flink-ci/flink/builds/147874247 TriggerType:MANUAL TriggerID:583260588
Hash:97fa61565812a6f2123c9c1cd87e9507d2633dfa Status:PENDING URL:https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4929 TriggerType:MANUAL TriggerID:583260652
-->
## CI report:
* 87d40c562765eb73acfc370039a590a2c98c5bd0 Travis: [FAILURE](https://travis-ci.com/flink-ci/flink/builds/147870982) Azure: [SUCCESS](https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4928)
* 97fa61565812a6f2123c9c1cd87e9507d2633dfa Travis: [PENDING](https://travis-ci.com/flink-ci/flink/builds/147874247) Azure: [PENDING](https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4929)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [flink] flinkbot edited a comment on issue #11035:
[FLINK-15902][python][doc] Improve the Python API doc adding the version an
API introduced
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on issue #11035: [FLINK-15902][python][doc] Improve the Python API doc adding the version an API introduced
URL: https://github.com/apache/flink/pull/11035#issuecomment-583237005
<!--
Meta data
Hash:87d40c562765eb73acfc370039a590a2c98c5bd0 Status:FAILURE URL:https://travis-ci.com/flink-ci/flink/builds/147870982 TriggerType:PUSH TriggerID:87d40c562765eb73acfc370039a590a2c98c5bd0
Hash:87d40c562765eb73acfc370039a590a2c98c5bd0 Status:SUCCESS URL:https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4928 TriggerType:PUSH TriggerID:87d40c562765eb73acfc370039a590a2c98c5bd0
Hash:97fa61565812a6f2123c9c1cd87e9507d2633dfa Status:FAILURE URL:https://travis-ci.com/flink-ci/flink/builds/147874247 TriggerType:PUSH TriggerID:97fa61565812a6f2123c9c1cd87e9507d2633dfa
Hash:97fa61565812a6f2123c9c1cd87e9507d2633dfa Status:FAILURE URL:https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4929 TriggerType:PUSH TriggerID:97fa61565812a6f2123c9c1cd87e9507d2633dfa
-->
## CI report:
* 87d40c562765eb73acfc370039a590a2c98c5bd0 Travis: [FAILURE](https://travis-ci.com/flink-ci/flink/builds/147870982) Azure: [SUCCESS](https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4928)
* 97fa61565812a6f2123c9c1cd87e9507d2633dfa Travis: [FAILURE](https://travis-ci.com/flink-ci/flink/builds/147874247) Azure: [FAILURE](https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4929)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [flink] dianfu commented on issue #11035:
[FLINK-15902][python][doc] Improve the Python API doc adding the version an
API introduced
Posted by GitBox <gi...@apache.org>.
dianfu commented on issue #11035: [FLINK-15902][python][doc] Improve the Python API doc adding the version an API introduced
URL: https://github.com/apache/flink/pull/11035#issuecomment-583260652
@flinkbot run azure
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [flink] flinkbot edited a comment on issue #11035:
[FLINK-15902][python][doc] Improve the Python API doc adding the version an
API introduced
Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on issue #11035: [FLINK-15902][python][doc] Improve the Python API doc adding the version an API introduced
URL: https://github.com/apache/flink/pull/11035#issuecomment-583237005
<!--
Meta data
Hash:87d40c562765eb73acfc370039a590a2c98c5bd0 Status:PENDING URL:https://travis-ci.com/flink-ci/flink/builds/147870982 TriggerType:PUSH TriggerID:87d40c562765eb73acfc370039a590a2c98c5bd0
Hash:87d40c562765eb73acfc370039a590a2c98c5bd0 Status:PENDING URL:https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4928 TriggerType:PUSH TriggerID:87d40c562765eb73acfc370039a590a2c98c5bd0
-->
## CI report:
* 87d40c562765eb73acfc370039a590a2c98c5bd0 Travis: [PENDING](https://travis-ci.com/flink-ci/flink/builds/147870982) Azure: [PENDING](https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=4928)
<details>
<summary>Bot commands</summary>
The @flinkbot bot supports the following commands:
- `@flinkbot run travis` re-run the last Travis build
- `@flinkbot run azure` re-run the last Azure build
</details>
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services