Skip to content
This repository was archived by the owner on Sep 18, 2024. It is now read-only.

Update Python API doc#3885

Merged
QuanluZhang merged 4 commits into
microsoft:masterfrom
kvartet:python-api-doc
Jul 16, 2021
Merged

Update Python API doc#3885
QuanluZhang merged 4 commits into
microsoft:masterfrom
kvartet:python-api-doc

Conversation

@kvartet

@kvartet kvartet commented Jun 30, 2021

Copy link
Copy Markdown
Contributor

In autoclass, for module data members and class attributes, documentation can either be put into a comment with special formatting (using a #: to start the comment instead of just #), or in a docstring after the definition.

.. autoattribute::
These work exactly like autoclass etc., but do not offer the options used for automatic member documentation.

refer here, so I can only list all the class attributes one by one... or we can add comments to every line in the code?

@QuanluZhang QuanluZhang requested review from ultmaster and removed request for liuzhe-lz July 9, 2021 07:14
@QuanluZhang QuanluZhang merged commit 7205cff into microsoft:master Jul 16, 2021
@kvartet kvartet deleted the python-api-doc branch October 16, 2021 07:08
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants