Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

slice function incorrectly cross-linking in docs #12914

Closed
aaronmarkham opened this issue Oct 22, 2018 · 4 comments · Fixed by #13160
Closed

slice function incorrectly cross-linking in docs #12914

aaronmarkham opened this issue Oct 22, 2018 · 4 comments · Fixed by #13160
Labels

Comments

@aaronmarkham
Copy link
Contributor

Description

Sphinx is confused with the multiple entries for slice.
Cross-linking might be going to the wrong place. For example, https://mxnet.incubator.apache.org/api/python/ndarray/sparse.html#mxnet.ndarray.sparse.CSRNDArray.__setitem__ has a slice() reference that points to symbol but it would seem this should be going to ndarray.

Similar to the issue with NDArray and optimizer: #12829

Can this be fixed by something like #12886 ?

Here's the error:

/home/ubuntu/incubator-mxnet/python/mxnet/ndarray/ndarray.py:docstring of mxnet.ndarray.NDArray.__setitem__:None: WARNING: more than one target found for cross-reference u'slice': mxnet.symbol.Symbol.slice, mxnet.ndarray.sparse.CSRNDArray.slice, mxnet.symbol.sparse.slice, mxnet.ndarray.slice, mxnet.ndarray.NDArray.slice, mxnet.ndarray.sparse.slice, mxnet.symbol.slice
/home/ubuntu/incubator-mxnet/python/mxnet/ndarray/ndarray.py:docstring of mxnet.ndarray.NDArray.__getitem__:None: WARNING: more than one target found for cross-reference u'slice': mxnet.symbol.Symbol.slice, mxnet.ndarray.sparse.CSRNDArray.slice, mxnet.symbol.sparse.slice, mxnet.ndarray.slice, mxnet.ndarray.NDArray.slice, mxnet.ndarray.sparse.slice, mxnet.symbol.slice

Steps to reproduce

make html (from the docs folder)

@aaronmarkham
Copy link
Contributor Author

@eric-haibin-lin - can you take a look... it seems part of this may have to do with the introduction of the sparse api.

@aaronmarkham
Copy link
Contributor Author

Related error with sparse:

/home/ubuntu/incubator-mxnet/python/mxnet/ndarray/__init__.py:docstring of mxnet.ndarray.add:None: WARNING: more than one target found for cross-reference u'array': mxnet.ndarray.array, mxnet.ndarray.sparse.array
/home/ubuntu/incubator-mxnet/python/mxnet/ndarray/__init__.py:docstring of mxnet.ndarray.add:None: WARNING: more than one target found for cross-reference u'array': mxnet.ndarray.array, mxnet.ndarray.sparse.array
/home/ubuntu/incubator-mxnet/python/mxnet/ndarray/__init__.py:docstring of mxnet.ndarray.divide:None: WARNING: more than one target found for cross-reference u'array': mxnet.ndarray.array, mxnet.ndarray.sparse.array
/home/ubuntu/incubator-mxnet/python/mxnet/ndarray/__init__.py:docstring of mxnet.ndarray.divide:None: WARNING: more than one target found for cross-reference u'array': mxnet.ndarray.array, mxnet.ndarray.sparse.array
/home/ubuntu/incubator-mxnet/python/mxnet/ndarray/__init__.py:docstring of mxnet.ndarray.equal:None: WARNING: more than one target found for cross-reference u'array': mxnet.ndarray.array, mxnet.ndarray.sparse.array
/home/ubuntu/incubator-mxnet/python/mxnet/ndarray/__init__.py:docstring of mxnet.ndarray.equal:None: WARNING: more than one target found for cross-reference u'array': mxnet.ndarray.array, mxnet.ndarray.sparse.array
/home/ubuntu/incubator-mxnet/python/mxnet/ndarray/__init__.py:docstring of mxnet.ndarray.greater:None: WARNING: more than one target found for cross-reference u'array': mxnet.ndarray.array, mxnet.ndarray.sparse.array
/home/ubuntu/incubator-mxnet/python/mxnet/ndarray/__init__.py:docstring of mxnet.ndarray.greater:None: WARNING: more than one target found for cross-reference u'array': mxnet.ndarray.array, mxnet.ndarray.sparse.array
{and a lot more of this...}

@aaronmarkham
Copy link
Contributor Author

And this one too:

/home/ubuntu/incubator-mxnet/python/mxnet/test_utils.py:docstring of mxnet.test_utils.rand_sparse_ndarray:None: WARNING: more than one target found for cross-reference u'dtype': mxnet.ndarray.sparse.CSRNDArray.dtype, mxnet.ndarray.sparse.RowSparseNDArray.dtype, mxnet.ndarray.NDArray.dtype

I can break this out as separate issues, but I get the feeling they're somewhat related around sparse.

@andrewfayres
Copy link
Contributor

@mxnet-label-bot [Doc]

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants