You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by shijinkui <gi...@git.apache.org> on 2016/11/26 08:16:50 UTC
[GitHub] flink pull request #2875: [FLINK-5168] Scaladoc annotation link use [[]] ins...
GitHub user shijinkui opened a pull request:
https://github.com/apache/flink/pull/2875
[FLINK-5168] Scaladoc annotation link use [[]] instead of {@link}
`{@link StreamExecutionEnvironment#readFile(FileInputFormat, * String, FileProcessingMode, long)}`
==>
`[StreamExecutionEnvironment#readFile(FileInputFormat, String, FileProcessingMode, long)]`
- [X] General
- The pull request references the related JIRA issue ("[FLINK-5168] Scaladoc annotation link use [[]] instead of {@link}")
- The pull request addresses only one issue
- Each commit in the PR has a meaningful commit message (including the JIRA id)
- [X] Documentation
- Documentation has been added for new functionality
- Old documentation affected by the pull request has been updated
- JavaDoc for public methods has been added
- [X] Tests & Build
- Functionality added by the pull request is covered by tests
- `mvn clean verify` has been executed successfully locally or a Travis build has passed
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/shijinkui/flink FLINK-5168
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/2875.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 #2875
----
commit c5deec42aa40efd788fa961d2979447f606a3cab
Author: shijinkui <sh...@huawei.com>
Date: 2016-11-26T08:14:13Z
[FLINK-5168] Scaladoc annotation link use [[]] instead of {@link}
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink issue #2875: [FLINK-5168] Scaladoc annotation link use [[]] instead of...
Posted by StephanEwen <gi...@git.apache.org>.
Github user StephanEwen commented on the issue:
https://github.com/apache/flink/pull/2875
Looks good, thanks!
Merging this...
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #2875: [FLINK-5168] Scaladoc annotation link use [[]] ins...
Posted by fhueske <gi...@git.apache.org>.
Github user fhueske commented on a diff in the pull request:
https://github.com/apache/flink/pull/2875#discussion_r89740442
--- Diff: flink-libraries/flink-gelly-scala/src/main/scala/org/apache/flink/graph/scala/Graph.scala ---
@@ -294,7 +294,7 @@ object Graph {
}
/**
- * Represents a graph consisting of {@link Edge edges} and {@link Vertex vertices}.
+ * Represents a graph consisting of [[Edge]] edgs and [[Vertex]] vertices.
--- End diff --
typo `edgs` -> `edges`
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #2875: [FLINK-5168] Scaladoc annotation link use [[]] ins...
Posted by shijinkui <gi...@git.apache.org>.
Github user shijinkui commented on a diff in the pull request:
https://github.com/apache/flink/pull/2875#discussion_r89750780
--- Diff: flink-libraries/flink-gelly-scala/src/main/scala/org/apache/flink/graph/scala/Graph.scala ---
@@ -294,7 +294,7 @@ object Graph {
}
/**
- * Represents a graph consisting of {@link Edge edges} and {@link Vertex vertices}.
+ * Represents a graph consisting of [[Edge]] edgs and [[Vertex]] vertices.
--- End diff --
\U0001f44d Fix it right now
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink issue #2875: [FLINK-5168] Scaladoc annotation link use [[]] instead of...
Posted by fhueske <gi...@git.apache.org>.
Github user fhueske commented on the issue:
https://github.com/apache/flink/pull/2875
Thanks for the PR @shijinkui. I found a typo that should be fixed.
Otherwise good to merge, IMO.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] flink pull request #2875: [FLINK-5168] Scaladoc annotation link use [[]] ins...
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/flink/pull/2875
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---