mirror of
https://github.com/davidhalter/jedi.git
synced 2025-12-07 22:44:27 +08:00
Docs: Reformat API return classes
This commit is contained in:
@@ -5,10 +5,42 @@
|
|||||||
API Return Classes
|
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:
|
:members:
|
||||||
:show-inheritance:
|
:show-inheritance:
|
||||||
:exclude-members: defined_names
|
|
||||||
|
|
||||||
.. autoclass:: jedi.api.errors.SyntaxError
|
.. autoclass:: jedi.api.errors.SyntaxError
|
||||||
:members:
|
:members:
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ There are a couple of classes documented in here:
|
|||||||
- :class:`.Completion` for completions
|
- :class:`.Completion` for completions
|
||||||
- :class:`.BaseSignature` as a base class for signatures
|
- :class:`.BaseSignature` as a base class for signatures
|
||||||
- :class:`.Signature` for :meth:`.Script.get_signatures` only
|
- :class:`.Signature` for :meth:`.Script.get_signatures` only
|
||||||
|
- :class:`.Refactoring` for refactorings
|
||||||
- :class:`.SyntaxError` for :meth:`.Script.get_syntax_errors` only
|
- :class:`.SyntaxError` for :meth:`.Script.get_syntax_errors` only
|
||||||
|
|
||||||
These classes are the much biggest part of the API, because they contain
|
These classes are the much biggest part of the API, because they contain
|
||||||
|
|||||||
Reference in New Issue
Block a user