Index

A

adapter (papertrail.core.collection.Recorder attribute) (papertrail.core.collection.recorder.Recorder attribute) args (papertrail.core.collection.Example attribute) (papertrail.core.collection.example.Example attribute) (papertrail.core.collection.ExampleRecord attribute) (papertrail.core.collection.record.ExampleRecord attribute)

C

collect_example_strs() (in module papertrail.core.transformation.format_examples)

create_replacements() (in module papertrail.core.transformation.ast_editing)

D

doc (papertrail.core.transformation.ast_editing.DocString attribute)

DocString (class in papertrail.core.transformation.ast_editing)

E

end_line (papertrail.core.transformation.ast_editing.DocString attribute) Example (class in papertrail.core.collection) (class in papertrail.core.collection.example) example() (in module papertrail), [1] (in module papertrail.core) (in module papertrail.core.collection) (in module papertrail.core.collection.example)

example_to_str() (in module papertrail.core.transformation.format_examples) ExampleRecord (class in papertrail.core.collection) (class in papertrail.core.collection.record) expected (papertrail.core.collection.ExampleRecord attribute) (papertrail.core.collection.record.ExampleRecord attribute)

F

files (papertrail.core.collection.Recorder attribute) (papertrail.core.collection.recorder.Recorder attribute) FileType (class in papertrail.adapters.io_funcs) fn (papertrail.core.collection.Example attribute) (papertrail.core.collection.example.Example attribute)

fn_name (papertrail.core.collection.ExampleRecord attribute) (papertrail.core.collection.record.ExampleRecord attribute) from_doc_node() (papertrail.core.transformation.ast_editing.DocString class method) from_non_doc_node() (papertrail.core.transformation.ast_editing.DocString class method)

I

indent (papertrail.core.transformation.ast_editing.DocString attribute)

J

JSON (papertrail.adapters.io_funcs.FileType attribute)

K

kwargs (papertrail.core.collection.Example attribute) (papertrail.core.collection.example.Example attribute) (papertrail.core.collection.ExampleRecord attribute) (papertrail.core.collection.record.ExampleRecord attribute)

M

module papertrail, [1] papertrail.adapters papertrail.adapters.io_funcs papertrail.core papertrail.core.collection papertrail.core.collection.example papertrail.core.collection.record papertrail.core.collection.recorder papertrail.core.logger papertrail.core.transformation papertrail.core.transformation.ast_editing papertrail.core.transformation.format_examples papertrail.core.transformation.transform

module (papertrail.core.collection.ExampleRecord attribute) (papertrail.core.collection.record.ExampleRecord attribute)

P

papertrail module, [1] papertrail.adapters module papertrail.adapters.io_funcs module papertrail.core module papertrail.core.collection module papertrail.core.collection.example module papertrail.core.collection.record module papertrail.core.collection.recorder module

papertrail.core.logger module papertrail.core.transformation module papertrail.core.transformation.ast_editing module papertrail.core.transformation.format_examples module papertrail.core.transformation.transform module path (papertrail.core.collection.Recorder attribute) (papertrail.core.collection.recorder.Recorder attribute) prepare_files() (papertrail.core.collection.Recorder method) (papertrail.core.collection.recorder.Recorder method)

R

read_json() (in module papertrail.adapters.io_funcs) read_str() (in module papertrail.adapters.io_funcs) record_example() (papertrail.core.collection.Recorder method) (papertrail.core.collection.recorder.Recorder method) Recorder (class in papertrail.core.collection) (class in papertrail.core.collection.recorder) recorder (papertrail.core.collection.Example attribute) (papertrail.core.collection.example.Example attribute)

records (papertrail.core.collection.Recorder attribute) (papertrail.core.collection.recorder.Recorder attribute) reduce_examples_to_example_str() (in module papertrail.core.transformation.format_examples) replace_docstrings() (in module papertrail.core.transformation.ast_editing) returned (papertrail.core.collection.ExampleRecord attribute) (papertrail.core.collection.record.ExampleRecord attribute)

S

src_file (papertrail.core.collection.ExampleRecord attribute) (papertrail.core.collection.record.ExampleRecord attribute)

start_line (papertrail.core.transformation.ast_editing.DocString attribute) STR (papertrail.adapters.io_funcs.FileType attribute)

T

to_dict() (papertrail.core.collection.ExampleRecord method) (papertrail.core.collection.record.ExampleRecord method)

to_doc() (papertrail.core.transformation.ast_editing.DocString method)

U

update_function_docstrings() (in module papertrail.core.transformation.ast_editing)

update_modified_docstrings() (in module papertrail.core.transformation.transform)

V

value (papertrail.core.collection.Example attribute) (papertrail.core.collection.example.Example attribute)

W

with_example() (papertrail.core.transformation.ast_editing.DocString method) write_examples() (papertrail.core.collection.Recorder method) (papertrail.core.collection.recorder.Recorder method)

write_json() (in module papertrail.adapters.io_funcs) write_str() (in module papertrail.adapters.io_funcs)