[GitHub] [incubator-mxnet] aaronmarkham commented on issue #13429: Wrong documentation in Optimization API

[GitBox <gi...@apache.org>]

aaronmarkham commented on issue #13429: Wrong documentation in Optimization API
URL: https://github.com/apache/incubator-mxnet/issues/13429#issuecomment-495700452
 
 
   Note: `NDAbs` also does not appear on the beta site at all... which is interesting...
   
   The source is here:
   https://github.com/apache/incubator-mxnet/blob/master/python/mxnet/optimizer/optimizer.py#L28
   Or more likely:
   https://github.com/apache/incubator-mxnet/blob/master/python/mxnet/optimizer/optimizer.py#L39
   
   It does not appear in the autosummary and is not listed in the docs for a signature to be provided.
   https://mxnet.incubator.apache.org/api/python/optimization/optimization.html?highlight=ndabs#the-mxnet-optimizer-package
   In the API Reference section, automodule is generating all members of optimizer, so this must be where it is coming from.
   Using this may fix it:
   ```
   :exclude-members: NDAbs
   ```
   But we also need to see why this doesn't appear on beta.
   

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


With regards,
Apache Git Services