[
https://issues.apache.org/jira/browse/MXNET-994?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Aaron Markham updated MXNET-994:
--------------------------------
Description:
This seems to be a pile of outputs from Sphinx autoclass and automodule.
I think I can see a pattern, but it is quite confusing to find anything. The
topics shift without header and the alphabetization restarts.
[https://mxnet.incubator.apache.org/api/python/symbol/symbol.html#mxnet.symbol.Symbol.save]
There's also evidence of missing API members in at least two APIs - focused on
the random ops:
[https://github.com/apache/incubator-mxnet/issues/12518#issuecomment-424889176]
Suggest breaking up these API doc pages according to topic/function for better
readability and validation that everything is being presented.
was:
This seems to be a pile of outputs from Sphinx autoclass and automodule.
I think I can see a pattern, but it is quite confusing to find anything. The
topics shift without header and the alphabetization restarts.
[https://mxnet.incubator.apache.org/api/python/symbol/symbol.html#mxnet.symbol.Symbol.save]
Suggest maybe breaking up these API doc pages according to topic/function for
better readability.
> API reference lists items non-alphabetically and non-categorically
> ------------------------------------------------------------------
>
> Key: MXNET-994
> URL: https://issues.apache.org/jira/browse/MXNET-994
> Project: Apache MXNet
> Issue Type: Bug
> Reporter: Aaron Markham
> Priority: Major
>
> This seems to be a pile of outputs from Sphinx autoclass and automodule.
> I think I can see a pattern, but it is quite confusing to find anything. The
> topics shift without header and the alphabetization restarts.
> [https://mxnet.incubator.apache.org/api/python/symbol/symbol.html#mxnet.symbol.Symbol.save]
> There's also evidence of missing API members in at least two APIs - focused
> on the random ops:
> [https://github.com/apache/incubator-mxnet/issues/12518#issuecomment-424889176]
>
> Suggest breaking up these API doc pages according to topic/function for
> better readability and validation that everything is being presented.
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
