Docs: Reformat API return classes

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

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:

View File

@@ -6,6 +6,7 @@ There are a couple of classes documented in here:
- :class:`.Completion` for completions
- :class:`.BaseSignature` as a base class for signatures
- :class:`.Signature` for :meth:`.Script.get_signatures` only
- :class:`.Refactoring` for refactorings
- :class:`.SyntaxError` for :meth:`.Script.get_syntax_errors` only
These classes are the much biggest part of the API, because they contain