Add docstring documentation to all llvm.core classes.
Some classes have docstrings, and lack rST docs (e.g. Module), few others vice versa. It's unclear what is the best way to deal with this. IMHO, docstrings should prevail, i.e. existing docs would rather be moved to docstings. Anyway, for now just make sure that users don't miss documentation, even if it's just list of classmembers.
This commit is contained in:
parent
d74ff4dc2b
commit
d36cd1dbc7
18 changed files with 122 additions and 0 deletions
|
|
@ -42,3 +42,10 @@ The parent function of this basicblock.
|
|||
~~~~~~~~~~~~~~~~
|
||||
|
||||
A list of instructions in this basicblock.
|
||||
|
||||
|
||||
Automatically Generated Documentation
|
||||
-------------------------------------
|
||||
.. autoclass:: llvm.core.BasicBlock
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue