[
https://issues.apache.org/jira/browse/FLINK-10924?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16692013#comment-16692013
]
ASF GitHub Bot commented on FLINK-10924:
----------------------------------------
TisonKun opened a new pull request #7143: [FLINK-10924] [javadoc]
StreamExecutionEnvironment method javadocs in…
URL: https://github.com/apache/flink/pull/7143
…correct in regards to used charset
## What is the purpose of the change
Various methods of the `StreamExecutionEnvironment` (like `readTextFile`)
are documented to be using the system's default charset if none is specified.
This is incorrect as they default to UTF-8 instead. The javadocs should be
updated to reflect this.
## Brief change log
Correct the corresponding javadoc("the system's default character set" to
"the UTF-8 character set").
## Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
## 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)`:(**yes, just its javadocs**)
- 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**)
cc @zentol
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
> StreamExecutionEnvironment method javadocs incorrect in regards to used
> charset
> -------------------------------------------------------------------------------
>
> Key: FLINK-10924
> URL: https://issues.apache.org/jira/browse/FLINK-10924
> Project: Flink
> Issue Type: Bug
> Components: Documentation, Streaming
> Affects Versions: 1.3.3, 1.4.2, 1.5.5, 1.6.2, 1.7.0
> Reporter: Chesnay Schepler
> Assignee: TisonKun
> Priority: Major
> Labels: pull-request-available
>
> Various methods of the {{StreamExecutionEnvironment}} (like
> [readTextFile|https://github.com/apache/flink/blob/master/flink-streaming-java/src/main/java/org/apache/flink/streaming/api/environment/StreamExecutionEnvironment.java#L939])
> are documented to be using the system's default charset if none is specified.
> This is incorrect as they default to UTF-8 instead. The javadocs should be
> updated to reflect this.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
