VimPlug/jedi
1
0
Fork 1
mirror of https://github.com/davidhalter/jedi.git synced 2025-12-06 14:04:26 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: Reformat API return classes

Browse Source
This commit is contained in:
Dave Halter
2020-03-17 08:34:51 +01:00
parent 3276db0bdc
commit 4a065642f2
2 changed files with 35 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/docs/api-classes.rst
View File

@@ -5,10 +5,42 @@
API Return Classes
------------------
.. automodule:: jedi.api.classes
Abstract Base Class
~~~~~~~~~~~~~~~~~~~
.. autoclass:: jedi.api.classes.BaseDefinition
:members:
:show-inheritance:
Name
~~~~
.. autoclass:: jedi.api.classes.Definition
:members:
:show-inheritance:
Completion
~~~~~~~~~~
.. autoclass:: jedi.api.classes.Completion
:members:
:show-inheritance:
BaseSignature
~~~~~~~~~~~~~
.. autoclass:: jedi.api.classes.BaseSignature
:members:
:show-inheritance:
Signature
~~~~~~~~~~
.. autoclass:: jedi.api.classes.Signature
:members:
:show-inheritance:
Refactoring
~~~~~~~~~~~
.. autoclass:: jedi.api.refactoring.Refactoring
:members:
:show-inheritance:
:exclude-members: defined_names
.. autoclass:: jedi.api.errors.SyntaxError
:members: