summaryrefslogtreecommitdiff
path: root/docs/internals/contributing/writing-code/coding-style.txt
AgeCommit message (Collapse)Author
2025-10-16Bumped minimum isort version to 7.0.0.Jacob Walls
Added ignores relating to https://github.com/PyCQA/isort/issues/2352.
2025-10-13Cautioned against multi-level relative imports in coding style docs.lyova24
2025-08-28Ensured :doc: role uses absolute targets in docs.Adam Johnson
2025-08-28Fixed #36570 -- Removed unnecessary :py domain from documentation roles.SaJH
Signed-off-by: SaJH <wogur981208@gmail.com>
2025-08-25Refs #36485 -- Rewrapped docs to 79 columns line length.David Smith
Lines in the docs files were manually adjusted to conform to the 79 columns limit per line (plus newline), improving readability and consistency across the content.
2025-08-23Removed reference to flake8 file exclusions.Jacob Walls
Obsolete since 41384812efe209c8295a50d78b45e0ffb2992436. (six was removed in 9285926295fbfc86b70e7be8d595d4cfbe7895b8.)
2025-07-23Fixed #36500 -- Set flake8 max-doc-length config to 79 columns.Mike Edmunds
Set flake8 max-doc-length to 79 to enforce smaller line length limit on docstrings and comments (per coding-style docs). Updated docs to clarify both requirements are enforced by flake8 and to remove some leftover language from the pre-black era.
2025-03-31Fixes #36215 -- Included unpacking generalization notes in coding style ↵Aarni Koskela
guide (PEP-448).
2024-10-30Fixed #35866 -- Clarified the positioning Python magic methods on models in ↵maddrum
the internal style guide.
2024-08-05Used :pypi: role in docs where appropriate.Mariusz Felisiak
2024-06-24Migrated setuptools configuration to pyproject.toml.Claude Paroz
This branch migrates setuptools configuration from setup.py/setup.cfg to pyproject.toml. In order to ensure that the generated binary files have consistent casing (both the tarball and the wheel), setuptools version is limited to ">=61.0.0,<69.3.0". Configuration for flake8 was moved to a dedicated .flake8 file since it cannot be configured via pyproject.toml. Also, __pycache__ exclusion was removed from MANIFEST and the extras/Makefile was replaced with a simpler build command. Co-authored-by: Nick Pope <nick@nickpope.me.uk>
2024-03-11Fixed #14831 -- Extended template style guide in docs.Ryan Cheley
2024-03-06Fixed broken links and redirects in docs.Mariusz Felisiak
2024-02-08Fixed typo in docs/internals/contributing/writing-code/coding-style.txt.Koo
2024-01-26Applied Black's 2024 stable style.Mariusz Felisiak
https://github.com/psf/black/releases/tag/24.1.0
2023-08-30 Fixed #31262 -- Added support for mappings on model fields and ↵Nick Pope
ChoiceField's choices.
2023-04-17Used extlinks for PyPI links.Tim Graham
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2023-03-30Fixed #34446 -- Removed unneeded and incorrect example in coding style docs.JiriKr
2023-03-01Fixed #34140 -- Reformatted code blocks in docs with blacken-docs.django-bot
2023-02-28Refs #34140 -- Corrected rst code-block and various formatting issues in docs.Joseph Victor Zammit
2022-05-31Fixed docs build with sphinxcontrib-spelling 7.5.0+.Mariusz Felisiak
sphinxcontrib-spelling 7.5.0+ includes captions of figures in the set of nodes for which the text is checked.
2022-05-17Removed versionadded/changed annotations for 4.0.Carlton Gibson
2022-02-21Refs #33476 -- Mentioned black in docs about pre-commit checks.Vaarun Sinha
2022-02-07Refs #33476 -- Adjusted docs and config files for Black.Carlton Gibson
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2021-11-22Corrected isort example in coding style docs.Mariusz Felisiak
Follow up to e74b3d724e5ddfef96d1d66bd1c58e7aae26fc85.
2021-11-22Corrected "pip install" call in coding style docs.Paolo Melchiorre
2021-06-03Fixed typos in docs.Jacob Walls
2021-06-02Fixed typo in docs/internals/contributing/writing-code/coding-style.txt.Jacob Walls
2021-01-09Fixed typo in docs/internals/contributing/writing-code/coding-style.txt.hashlash
2020-12-23Refs #30367 -- Changed remaining "pip install" to "python -m pip install" in ↵Jon Dufresne
docs.
2020-12-23Fixed #32165 -- Added pre-commit hooksDavid Smith
* Added pre-commit hooks for isort, flake8 and eslint * Added documentation on how to install and use the tool
2020-12-20Updated isort URL to new location.Jon Dufresne
2020-10-15Fixed #29988 -- Updated coding style to allow f-strings.Carlton Gibson
Thanks to Nick Pope for review.
2020-07-30Bumped minimum isort version to 5.1.0.David Smith
Fixed inner imports per isort 5. isort 5.0.0 to 5.1.0 was unstable.
2020-05-13Used :envvar: role and .. envvar:: directive in various docs.Nick Pope
2019-12-30Added guidelines for assertIs() usage.Mads Jensen
2019-05-15Changed tuple choices to list in docs.Jon Dufresne
2019-04-18Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, ↵Ramiro Morales
comments and hints.
2018-11-02Fixed typo in docs/internals/contributing/writing-code/coding-style.txt.Mice Pápai
2018-09-26Refs #29784 -- Switched to https:// links where available.Jon Dufresne
2018-09-25Normalized spelling of "lowercase" and "lowercased".Jon Dufresne
2018-09-10Refs #20910 -- Replaced snippet directive with code-block.Curtis Maloney
2018-07-18Removed duplicate words in docs.Maxime Lorant
.
2018-05-09Fixed #29363 -- Added SimpleTestCase.assertWarnsMessage().Morgan Aubert
2018-04-17Fixed #29334 -- Updated pypi.python.org URLs to pypi.org.Brett Cannon
2018-01-20Fixed #28343 -- Add an OS chooser for docs command line examples.Ramiro Morales
2017-06-26Refs #23919 -- Stopped inheriting from object to define new style classes.Mariusz Felisiak
Tests and docs complement to cecc079168e8669138728d31611ff3a1e7eb3a9f.
2017-06-12Fixed #27655 -- Added some guidelines to the coding style docs.Tim Graham
2017-03-21Fixed #27963 -- Removed unneeded docstring example in contributing docs.Mikkel Munch Mortensen
2017-01-18Refs #23919 -- Removed python_2_unicode_compatible decorator usageClaude Paroz
generated by cgit v1.3 (git 2.53.0) at 2026-05-02 05:43:45 +0000