Document api.Interpreter

This commit is contained in:
Takafumi Arakaki
2013-03-12 16:14:03 +01:00
parent 8fc396371c
commit e8914e7856
2 changed files with 6 additions and 2 deletions

View File

@@ -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']

View File

@@ -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