From 4a065642f22a6e5fa3a38b3093a9e08376879791 Mon Sep 17 00:00:00 2001 From: Dave Halter Date: Tue, 17 Mar 2020 08:34:51 +0100 Subject: [PATCH] Docs: Reformat API return classes --- docs/docs/api-classes.rst | 36 ++++++++++++++++++++++++++++++++++-- jedi/api/classes.py | 1 + 2 files changed, 35 insertions(+), 2 deletions(-) diff --git a/docs/docs/api-classes.rst b/docs/docs/api-classes.rst index 30a2eb3b..351dea41 100644 --- a/docs/docs/api-classes.rst +++ b/docs/docs/api-classes.rst @@ -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: diff --git a/jedi/api/classes.py b/jedi/api/classes.py index d0bb4fa0..77d0819d 100644 --- a/jedi/api/classes.py +++ b/jedi/api/classes.py @@ -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