You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mxnet.apache.org by GitBox <gi...@apache.org> on 2018/10/29 21:11:17 UTC
[GitHub] aaronmarkham opened a new issue #13008: RecordIO API docs errors
aaronmarkham opened a new issue #13008: RecordIO API docs errors
URL: https://github.com/apache/incubator-mxnet/issues/13008
## 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.
```
----------------------------------------------------------------
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:
users@infra.apache.org
With regards,
Apache Git Services