From e8914e78569e6df70ebf359429313e9a288b145e Mon Sep 17 00:00:00 2001 From: Takafumi Arakaki Date: Tue, 12 Mar 2013 16:14:03 +0100 Subject: [PATCH] Document api.Interpreter --- docs/conf.py | 1 + jedi/api.py | 7 +++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 20bfc6a3..1dfb18c4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -267,6 +267,7 @@ todo_include_todos = False # -- Options for autodoc module ------------------------------------------------ +autoclass_content = 'both' autodoc_member_order = 'bysource' autodoc_default_flags = [] #autodoc_default_flags = ['members', 'undoc-members'] diff --git a/jedi/api.py b/jedi/api.py index 7b325933..96d88ceb 100644 --- a/jedi/api.py +++ b/jedi/api.py @@ -529,11 +529,14 @@ class Interpreter(Script): Parse `source` and mixin interpreted Python objects from `namespaces`. :type source: str - :arg source: + :arg source: Code to parse. :type namespaces: list of dict - :arg namespaces: + :arg namespaces: a list of namespace dictionaries such as the one + returned by :func:`locals`. Other optional arguments are same as the ones for :class:`Script`. + If `line` and `column` are None, they are assumed be at the end of + `source`. """ lines = source.splitlines() line = len(lines) if line is None else line