VimPlug/django-stubs
1
0
Fork 0
mirror of https://github.com/davidhalter/django-stubs.git synced 2025-12-10 05:51:53 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update django_stubs_ext documentation to reference settings (#548)

Browse Source
This commit is contained in:
markedwards
2020-12-19 08:50:46 +00:00
committed by GitHub
parent 36d1778e2a
commit 47bd07758b
2 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -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.

4
django_stubs_ext/README.md
View File

@@ -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