[
https://issues.apache.org/jira/browse/TINKERPOP-1301?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15293344#comment-15293344
]
ASF GitHub Bot commented on TINKERPOP-1301:
-------------------------------------------
Github user okram commented on a diff in the pull request:
https://github.com/apache/incubator-tinkerpop/pull/314#discussion_r64039957
--- Diff:
hadoop-gremlin/src/main/java/org/apache/tinkerpop/gremlin/hadoop/structure/io/script/ScriptOutputFormat.java
---
@@ -29,6 +29,12 @@
import java.io.IOException;
/**
+ * {@link
org.apache.tinkerpop.gremlin.hadoop.structure.io.script.ScriptInputFormat}
+ * and ScriptOutputFormat take an arbitrary script and use that script to
either
+ * read or write Vertex objects, respectively. This can be considered the
most
+ * general InputFormat/OutputFormat possible in that Hadoop-Gremlin uses
the user
+ * provided script for all reading/writing.
+ * @see <a
href="http://tinkerpop.apache.org/docs/3.2.0-incubating/reference/#script-io-format";>Script
I/O Format Reference Documentation</a>
--- End diff --
The problem with having direct URLs in here is that we have to remember to
update them with every release. I would remove this if there is no automated
way of doing this in our release process.
> Provide Javadoc for ScriptInput/OutputFormat's
> ----------------------------------------------
>
> Key: TINKERPOP-1301
> URL: https://issues.apache.org/jira/browse/TINKERPOP-1301
> Project: TinkerPop
> Issue Type: Improvement
> Components: documentation
> Affects Versions: 3.2.0-incubating
> Reporter: Lewis John McGibbney
> Priority: Minor
>
> Right now
> [ScriptInputFormat|http://tinkerpop.apache.org/javadocs/3.2.1-SNAPSHOT/full/index.html?org/apache/tinkerpop/gremlin/hadoop/structure/io/script/ScriptInputFormat.html]
> and
> [ScriptOutputFormat|http://tinkerpop.apache.org/javadocs/3.2.1-SNAPSHOT/full/index.html?org/apache/tinkerpop/gremlin/hadoop/structure/io/script/ScriptOutputFormat.html]
> are not documented. Descriptions are however present over on some old
> [TitanDB
> documentation|http://s3.thinkaurelius.com/docs/titan/0.5.0/script-io-format.html]
> which can be used to provide Javadoc level documentation for developers.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
