sojiadeshina commented on a change in pull request #16392: [WIP] Improving
Python Docs API
URL: https://github.com/apache/incubator-mxnet/pull/16392#discussion_r332822432
##########
File path: docs/python_docs/python/api/gluon/nn/index.rst
##########
@@ -36,46 +36,24 @@ We group all layers in these two modules according to
their categories.
.. currentmodule:: mxnet.gluon
-Blocks
-------
-
-.. autosummary::
- :nosignatures:
- :toctree: .
-
- nn.Block
- nn.HybridBlock
- nn.SymbolBlock
Sequential containers
---------------------
.. autosummary::
- :toctree: _autogen
:nosignatures:
Review comment:
This is an aesthetic/readability choice and the idea here is similar to the
comment in the other issue. Here the doc is listing different classes under the
different groupings so there's no need to have the method signatures.
At the bottom when autosummary generates an alphabetical listing of the
classes, the method signatures are included.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
With regards,
Apache Git Services
