[
https://issues.apache.org/jira/browse/FLINK-8004?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16241815#comment-16241815
]
ASF GitHub Bot commented on FLINK-8004:
---------------------------------------
GitHub user zentol opened a pull request:
https://github.com/apache/flink/pull/4965
[FLINK-8004][metrics][docs] Fix usage examples
## What is the purpose of the change
This PR fixes several issues in the metric usage examples in the
documentation.
## Brief change log
* remove wrong `@public` sections with a proper `@Override` a dpublic
modifier
* stream line all examples to just return the input (required adjusting
types)
* added missing return statements
* modified all examples to override all required methods (open() & map())
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/zentol/flink 8004
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/4965.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #4965
----
commit 984473a58a70daf09d7d0cc2f409c05d391a4be1
Author: zentol <[email protected]>
Date: 2017-11-07T10:40:15Z
[FLINK-8004][metrics][docs] Fix usage examples
----
> Sample code in Debugging & Monitoring Metrics documentation section is not
> valid java
> --------------------------------------------------------------------------------------
>
> Key: FLINK-8004
> URL: https://issues.apache.org/jira/browse/FLINK-8004
> Project: Flink
> Issue Type: Improvement
> Reporter: Andreas Hecke
> Assignee: Chesnay Schepler
> Priority: Minor
>
> Hi, we have been stumbled about some documentation inconsistencies in how to
> use metrics in flink. Seems there is some invalid java code posted as samples
> like having methods declared as @public and missing return statements, see
> [here|https://ci.apache.org/projects/flink/flink-docs-release-1.3/monitoring/metrics.html#counter]
> I raised a question on
> [SO|https://stackoverflow.com/questions/47153424/what-does-public-modifier-mean-in-method-signature]
> and Fabian asked me to open a Jira issue
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
