You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@mxnet.apache.org by "Piyush Ghai (JIRA)" <ji...@apache.org> on 2019/02/05 20:17:00 UTC
[jira] [Commented] (MXNET-1270) Update Scala API classes to
generate scaladocs for them
[ https://issues.apache.org/jira/browse/MXNET-1270?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16761169#comment-16761169 ]
Piyush Ghai commented on MXNET-1270:
------------------------------------
I enabled the ScalaDoc check and it threw up with over 1200 violations of Scala Doc Style.
This needs to be a group effort in trying to minimize the violations. We cannot bring it down to 0, as scala docs checker seems to complain about missing docs on private methods as well.
> Update Scala API classes to generate scaladocs for them
> -------------------------------------------------------
>
> Key: MXNET-1270
> URL: https://issues.apache.org/jira/browse/MXNET-1270
> Project: Apache MXNet
> Issue Type: Improvement
> Components: Apache MXNet Scala API
> Reporter: Denis Davydenko
> Assignee: Piyush Ghai
> Priority: Major
>
> Some of the Scala API classes are missing scaladocs annotations, for example DataIter. We need to go over Scala API classes and ensure that all of them have scaladocs annotations.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@mxnet.apache.org
For additional commands, e-mail: issues-help@mxnet.apache.org