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

RecordIO API docs errors #13008

Closed
aaronmarkham opened this issue Oct 29, 2018 · 1 comment · Fixed by #13160
Closed

RecordIO API docs errors #13008

aaronmarkham opened this issue Oct 29, 2018 · 1 comment · Fixed by #13160
Labels

Comments

@aaronmarkham
Copy link
Contributor

Description

Sphinx throws several errors when generating the RecordIO API docs.

Error

/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXRecordIO:4: WARNING: Title underline too short.

Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXRecordIO:4: SEVERE: Unexpected section title.

Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXRecordIO.reset:6: WARNING: Title underline too short.

Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXRecordIO.reset:6: SEVERE: Unexpected section title.

Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXRecordIO.write:4: WARNING: Title underline too short.

Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXRecordIO.write:4: SEVERE: Unexpected section title.

Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXRecordIO.read:4: WARNING: Title underline too short.

Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXRecordIO.read:4: SEVERE: Unexpected section title.

Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXIndexedRecordIO:4: WARNING: Title underline too short.

Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXIndexedRecordIO:4: SEVERE: Unexpected section title.

Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXIndexedRecordIO.tell:4: WARNING: Title underline too short.

Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXIndexedRecordIO.tell:4: SEVERE: Unexpected section title.

Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXIndexedRecordIO.read_idx:4: WARNING: Title underline too short.

Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXIndexedRecordIO.read_idx:4: SEVERE: Unexpected section title.

Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXIndexedRecordIO.write_idx:4: WARNING: Title underline too short.

Example usage:
----------
/home/ubuntu/incubator-mxnet/python/mxnet/recordio.py:docstring of mxnet.recordio.MXIndexedRecordIO.write_idx:4: SEVERE: Unexpected section title.

@frankfliu
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