From 47bd07758b89a12b19c6e6d8c1f73e22cbd6777e Mon Sep 17 00:00:00 2001 From: markedwards Date: Sat, 19 Dec 2020 08:50:46 +0000 Subject: [PATCH] Update django_stubs_ext documentation to reference settings (#548) --- README.md | 4 ++-- django_stubs_ext/README.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 91afcee..fa36ac1 100644 --- a/README.md +++ b/README.md @@ -90,12 +90,12 @@ Install it: pip install django-stubs-ext # as a production dependency ``` -And then place in your `manage.py`, `wsgi.py`, and `asgi.py` files: +And then place in your top-level settings: ```python import django_stubs_ext -django_stubs_ext.monkeypath() +django_stubs_ext.monkeypatch() ``` 2. You can use strings instead: `'QuerySet[MyModel]'` and `'Manager[MyModel]'`, this way it will work as a type for `mypy` and as a regular `str` in runtime. diff --git a/django_stubs_ext/README.md b/django_stubs_ext/README.md index c216503..3680d6a 100644 --- a/django_stubs_ext/README.md +++ b/django_stubs_ext/README.md @@ -20,10 +20,10 @@ In your Django application, use the following code: ```py import django_stubs_ext -django_stubs_ext.monkeypath() +django_stubs_ext.monkeypatch() ``` -This only needs to be called once, so the call to `monkeypatch` should be placed in your top-level urlconf. +This only needs to be called once, so the call to `monkeypatch` should be placed in your top-level settings. ## Version compatibility