Skip to content

Commit 26f5736

Browse files
committed
minor changes
1 parent e0f35a9 commit 26f5736

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/tracing_ext.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# method_call_ctx_factory - tracing extention of pandas_flavor
22

33
`method_call_ctx_factory` global var defined in [pandas_flavor/register.py](https://github.com/pyjanitor-devs/pandas_flavor/blob/c60bfd43adbcc304b3455055af73ed9fc9ac10d1/pandas_flavor/register.py#L8) is used
4-
as an extention to allow registered method to be traced.
4+
to allow the methods registered via `pandas_flavors` to be traced.
55

6-
Default value of `method_call_ctx_factory` is None.
6+
Default value of `method_call_ctx_factory` is None.
77

8-
Starting version 0.5.0 `pandas_flavor` implements the way to pass registerd method name, signature and parameters to
8+
Starting version 0.5.0 `pandas_flavor` implements the way to pass registered method name, signature and parameters to
99
be handled by user-defined object when the call is made. To allow this the user of pandas_flavor must set
1010
`method_call_ctx_factory` to refer to function with signature `(method_name: str, method_args: list, method_kwargs: dict) -> tracing_ctx`.
1111
`tracing_ctx` should be class which implements methods with signatures as below:
@@ -29,4 +29,4 @@ So `handle_start_method_call` and `handle_end_method_call` will have the chance
2929
Aslo, __exit__ method will be called if any exception would occur. This way it is possible to handle the situation of
3030
actual method ends by raising exception.
3131

32-
The example of tracer class implementation and factory function registration is given in [tracing_ext-demo.py...](...)
32+
The example of tracer class implementation and factory function registration is given in [tracing_ext-demo.py](/docs/tracing_ext-demo.py)

0 commit comments

Comments
 (0)