Skip to content

Commit 9e30a06

Browse files
authored
Add a paragraph describing our stance on Python typing (#1979)
1 parent 45cbf41 commit 9e30a06

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

docs/contributing.rst

+16-4
Original file line numberDiff line numberDiff line change
@@ -112,10 +112,10 @@ For MySQL/MariaDB in a ``mysql`` shell::
112112
Style
113113
-----
114114

115-
The Django Debug Toolbar uses `black <https://github.com/psf/black>`__ to
116-
format code and additionally uses ruff. The toolbar uses
117-
`pre-commit <https://pre-commit.com>`__ to automatically apply our style
118-
guidelines when a commit is made. Set up pre-commit before committing with::
115+
The Django Debug Toolbar uses `ruff <https://github.com/astral-sh/ruff/>`__ to
116+
format and lint Python code. The toolbar uses `pre-commit
117+
<https://pre-commit.com>`__ to automatically apply our style guidelines when a
118+
commit is made. Set up pre-commit before committing with::
119119

120120
$ pre-commit install
121121

@@ -129,6 +129,18 @@ To reformat the code manually use::
129129

130130
$ pre-commit run --all-files
131131

132+
133+
Typing
134+
------
135+
136+
The Debug Toolbar has been accepting patches which add type hints to the code
137+
base, as long as the types themselves do not cause any problems or obfuscate
138+
the intent.
139+
140+
The maintainers are not committed to adding type hints and are not requiring
141+
new code to have type hints at this time. This may change in the future.
142+
143+
132144
Patches
133145
-------
134146

0 commit comments

Comments
 (0)