Skip to content

Commit c84e7f0

Browse files
committed
fix markdownlint violations in README
1 parent 1c482dc commit c84e7f0

File tree

1 file changed

+2
-10
lines changed

1 file changed

+2
-10
lines changed

README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,8 @@
77
[![Gitter](https://badges.gitter.im/mypy-django/Lobby.svg)](https://gitter.im/mypy-django/Lobby)
88
[![StackOverflow](https://shields.io/badge/ask-stackoverflow-orange?logo=stackoverflow)](https://stackoverflow.com/questions/tagged/django-stubs)
99

10-
1110
This package contains [type stubs](https://www.python.org/dev/peps/pep-0561/) and a custom mypy plugin to provide more precise static types and type inference for Django framework. Django uses some Python "magic" that makes having precise types for some code patterns problematic. This is why we need this project. The final goal is to be able to get precise types for most common patterns.
1211

13-
1412
## Installation
1513

1614
```bash
@@ -68,7 +66,6 @@ We rely on different `django` and `mypy` versions:
6866
| 1.1.0 | 0.720 | 2.2.x | ^3.6
6967
| 0.12.x | old semantic analyzer (<0.711), dmypy support | 2.1.x | ^3.6
7068

71-
7269
## FAQ
7370

7471
### Is this an official Django project?
@@ -128,6 +125,7 @@ Django's built in [`HttpRequest`](https://docs.djangoproject.com/en/4.0/ref/requ
128125
```python
129126
Union[User, AnonymousUser]
130127
```
128+
131129
where `User` is the user model specified by the `AUTH_USER_MODEL` setting.
132130

133131
If you want a `HttpRequest` that you can type-annotate with where you know that the user is authenticated you can subclass the normal `HttpRequest` class like so:
@@ -143,7 +141,6 @@ class AuthenticatedHttpRequest(HttpRequest):
143141

144142
And then use `AuthenticatedHttpRequest` instead of the standard `HttpRequest` for when you know that the user is authenticated. For example in views using the `@login_required` decorator.
145143

146-
147144
### My QuerySet methods are returning Any rather than my Model
148145

149146
If you are using `MyQuerySet.as_manager()`:
@@ -208,9 +205,7 @@ class MyManager(model.Manager):
208205

209206
will cause this error message:
210207

211-
```
212-
error: Return type "MyModel" of "create" incompatible with return type "_T" in supertype "BaseManager"
213-
```
208+
> error: Return type "MyModel" of "create" incompatible with return type "_T" in supertype "BaseManager"
214209
215210
This is happening because the `Manager` class is generic, but without
216211
specifying generics the built-in manager methods are expected to return the
@@ -296,16 +291,13 @@ def foo(obj: object) -> None:
296291
...
297292
```
298293

299-
300294
## Related projects
301295

302296
- [`awesome-python-typing`](https://github.com/typeddjango/awesome-python-typing) - Awesome list of all typing-related things in Python.
303297
- [`djangorestframework-stubs`](https://github.com/typeddjango/djangorestframework-stubs) - Stubs for Django REST Framework.
304298
- [`pytest-mypy-plugins`](https://github.com/typeddjango/pytest-mypy-plugins) - `pytest` plugin that we use for testing `mypy` stubs and plugins.
305299
- [`wemake-django-template`](https://github.com/wemake-services/wemake-django-template) - Create new typed Django projects in seconds.
306300

307-
308-
309301
## To get help
310302

311303
We have Gitter here: <https://gitter.im/mypy-django/Lobby>

0 commit comments

Comments
 (0)