mxnet
mxnet copied to clipboard
apache
Documentation Bug: Format issue in mxnet.util.use_np document
Description
This is a documentation bug. There is a format issue in mxnet.util.use_np document Parameter section. and NumPy-array semantics. is not a parameter.
Error Message
None
To Reproduce
Link to the buggy document: https://mxnet.apache.org/versions/1.6/api/python/docs/api/mxnet/util/index.html#mxnet.util.use_np
Steps to reproduce
(Paste the commands you ran that produced the error.)
What have you tried to solve it?
Environment
We recommend using our script for collecting the diagnositc information. Run the following command and paste the outputs below:
curl --retry 10 -s https://raw.githubusercontent.com/dmlc/gluon-nlp/master/tools/diagnose.py | python
# paste outputs here
OS: ubuntu 18.04 Python: 3.7.6 pip: 20.0.2 numpy: 1.18.5 mxnet: 1.6.0
The problem is the wrong doc string and indentation here: https://github.com/apache/incubator-mxnet/blob/3c4ac19daa3e645d918692b864ea19640f7e0314/python/mxnet/util.py#L541-L542
A proper documentation format looks like this: https://github.com/apache/incubator-mxnet/blob/3c4ac19daa3e645d918692b864ea19640f7e0314/python/mxnet/util.py#L773-L776
Hello, I see a PR merged for this issue. Is this still open?
@vijaya-lakshmi-venkatraman I don't think the issue is fixed. At least the document has not been updated.
@DNXie I am looking at the master version and dont see the second bullet point anymore however the description seems to be incomplete
Am I looking at the right version & the right place?
@vijaya-lakshmi-venkatraman Hi, it is fixed in the the master version. But in the 1.6 document, it still exists. Should we consider this as fixed?
@DNXie Isn't master the current live version? Do you prefer to have it fixed in 1.6 branch as well?