Commit 612ff488 authored by Bryton Lacquement's avatar Bryton Lacquement 🚪

Fix the documentation

parent 4901356b
...@@ -5,15 +5,15 @@ This documentation is rudimentary. ...@@ -5,15 +5,15 @@ This documentation is rudimentary.
## Apply "trace" fixers on the fly ## Apply "trace" fixers on the fly
* When importing modules: * When importing modules:
```python ```python
from my2to3.trace import patch_imports from my2to3.trace import patch_imports
def is_whitelisted(fullname, path): def is_whitelisted(fullname, path):
# This function is used to whitelist specific modules. This corresponds to # This function is used to whitelist specific modules. This corresponds to
# https://www.python.org/dev/peps/pep-0302/. # https://www.python.org/dev/peps/pep-0302/.
return True return True
patch_imports(is_whitelisted) patch_imports(is_whitelisted)
``` ```
...@@ -21,12 +21,12 @@ This documentation is rudimentary. ...@@ -21,12 +21,12 @@ This documentation is rudimentary.
```python ```python
from my2to3.trace import tracing_functions, apply_fixers from my2to3.trace import tracing_functions, apply_fixers
# `tracing_function` contains all the functions registered with # `tracing_functions` contains all the functions which trace data at runtime.
# `@register_tracing_function`. Add its content to the builtins (or # Add its content to the builtins (or equivalent) of the component to
# equivalent) of the component to monkey-patch, e.g.: # monkey-patch, e.g.:
component_builtins.update({f.__name__: f for f in tracing_functions}) component_builtins.update({f.__name__: f for f in tracing_functions})
# `name` must be a unique name which represents the code to modify, to easily # `name` must be a unique name which represents the code to modify, to easily
# recognize it. In general, we use a filepath (or an equivalent). This is used # recognize it. In general, we use a filepath (or an equivalent). This is used
# by the fixers. # by the fixers.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment