Skip to content

Commit

Permalink
Fix capitalisation and long lines
Browse files Browse the repository at this point in the history
  • Loading branch information
wesselb committed Jun 9, 2022
1 parent 08d6f16 commit 7e1813b
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Everybody likes multiple dispatch, just like everybody likes plums.
- [Add Multiple Methods](#add-multiple-methods)
- [Extend a Function From Another Package](#extend-a-function-from-another-package)
- [Directly Invoke a Method](#directly-invoke-a-method)
* [IPython's autoreload support](#support-for-ipython-autoreload)
* [Support for IPython Autoreload](#support-for-ipython-autoreload)

## Installation

Expand Down Expand Up @@ -1167,11 +1167,14 @@ def f(x: str):
'str'
```

### Support for IPython autoreload
### Support for IPython Autoreload

Plum does not work out of the box with IPython's autoreload, and if you reload a file where a class is defined, you will most likely break your dispatch table.
Plum does not work out of the box with
[IPython's autoreload extension](https://ipython.readthedocs.io/en/stable/config/extensions/autoreload.html),
and if you reload a file where a class is defined, you will most likely break your dispatch table.

However, experimental support for IPython's autoreload is included into plum but it is not enabled by default, as it overrides some internal methods of IPython.
However, experimental support for IPython's autoreload is included into Plum,
but it is not enabled by default, as it overrides some internal methods of IPython.
To activate it, either set the environment variable `PLUM_AUTORELOAD=1` **before** loading plum

```bash
Expand All @@ -1182,6 +1185,7 @@ or manually call the `autoreload.activate` method in an interactive session.

```python
import plum

plum.autoreload.activate()
```

Expand Down

0 comments on commit 7e1813b

Please sign in to comment.