aaronmarkham opened a new issue #13308: Scala API docs examples and discussion 
content & render inaccuracies 
URL: https://github.com/apache/incubator-mxnet/issues/13308
 
 
   ## Description
   
   The Scala API docs are generated using sources that have examples that are 
pythonic or otherwise not Scala example code. Also scaladocs isn't able to 
render the rst code that is extracted from the other sources. 
   
   Rather than include this info that doesn't render properly and is out of 
context, it would be better to link to the source material where it renders 
properly and makes sense in its original context. 
   
   Example:
   
[BilinearSampler](http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-13210/2/api/scala/docs/index.html#org.apache.mxnet.NDArrayAPI$@BilinearSampler(data:org.apache.mxnet.NDArray,grid:org.apache.mxnet.NDArray,cudnn_off:Option[Boolean],out:Option[org.apache.mxnet.NDArray]):org.apache.mxnet.NDArrayFuncReturn)
 would still have the inputs and returns info, but the detail would point to 
the [BilinearSampler Python API source 
docs](http://mxnet.incubator.apache.org/api/python/ndarray/ndarray.html?highlight=bilinearsampler#mxnet.ndarray.BilinearSampler).
   
   @andrewfayres @zachgk @lanking520 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


With regards,
Apache Git Services

Reply via email to