You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2015/09/09 15:58:36 UTC
incubator-tinkerpop git commit: Make see javadoc example in
deprecation more generic.
Repository: incubator-tinkerpop
Updated Branches:
refs/heads/tp30 a4928c0ea -> 00cb9f579
Make see javadoc example in deprecation more generic.
Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/00cb9f57
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/00cb9f57
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/00cb9f57
Branch: refs/heads/tp30
Commit: 00cb9f579c8a27dd3177d1484e6042801dafee69
Parents: a4928c0
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Wed Sep 9 09:58:11 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Wed Sep 9 09:58:11 2015 -0400
----------------------------------------------------------------------
CONTRIBUTING.asciidoc | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/00cb9f57/CONTRIBUTING.asciidoc
----------------------------------------------------------------------
diff --git a/CONTRIBUTING.asciidoc b/CONTRIBUTING.asciidoc
index 50a35a9..a44a574 100644
--- a/CONTRIBUTING.asciidoc
+++ b/CONTRIBUTING.asciidoc
@@ -162,7 +162,8 @@ public APIs that might be utilized by users or implemented by vendors:
** `@deprecated As of release x.y.z, replaced by {@link SomeOtherClass#someNewMethod()}` - if the method is not
replaced then the comment can simply read "not replaced". Additional comments that provide more context are
encouraged.
-** `@see <a href="https://issues.apache.org/jira/browse/TINKERPOP3-297">TINKERPOP3-297</a>`
+** `@see <a href="https://issues.apache.org/jira/browse/TINKERPOP3-XXX">TINKERPOP3-XXX</a>` - supply a link to the
+JIRA issue for reference.
* All deprecation should be tied to a JIRA issue with a "breaking" label - the issue itself does not need to
specifically or solely be about "deprecation" but it should be documented very clearly in the comments what was
deprecated and what the path forward should be.