1
0
mirror of https://github.com/django/django.git synced 2025-09-18 06:59:12 +00:00

80 Commits

Author SHA1 Message Date
Adam Johnson
56955636e6 Ensured :doc: role uses absolute targets in docs. 2025-08-28 13:48:32 -03:00
SaJH
3c0c54351b Fixed #36570 -- Removed unnecessary :py domain from documentation roles.
Signed-off-by: SaJH <wogur981208@gmail.com>
2025-08-28 08:52:43 +02:00
David Smith
f81e6e3a53 Refs #36485 -- Rewrapped docs to 79 columns line length.
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-25 10:51:10 -03:00
Jacob Walls
165ad74c57
Removed reference to flake8 file exclusions.
Obsolete since 41384812efe209c8295a50d78b45e0ffb2992436.
(six was removed in 9285926295fbfc86b70e7be8d595d4cfbe7895b8.)
2025-08-23 20:01:00 +02:00
Mike Edmunds
3ad0e759a6 Fixed #36500 -- Set flake8 max-doc-length config to 79 columns.
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-07-23 20:17:55 -03:00
Aarni Koskela
6b32506739 Fixes #36215 -- Included unpacking generalization notes in coding style guide (PEP-448). 2025-03-31 22:43:13 -03:00
maddrum
b50d1a020d Fixed #35866 -- Clarified the positioning Python magic methods on models in the internal style guide. 2024-10-30 16:21:57 +01:00
Mariusz Felisiak
304d256674
Used :pypi: role in docs where appropriate. 2024-08-05 10:35:50 -03:00
Claude Paroz
4686541691
Migrated setuptools configuration to pyproject.toml.
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-06-24 15:34:43 -03:00
Ryan Cheley
f2c3524959 Fixed #14831 -- Extended template style guide in docs. 2024-03-11 11:05:54 +01:00
Mariusz Felisiak
177e649396
Fixed broken links and redirects in docs. 2024-03-06 08:50:21 +01:00
Koo
aaffbabd58
Fixed typo in docs/internals/contributing/writing-code/coding-style.txt. 2024-02-08 05:57:59 +01:00
Mariusz Felisiak
305757aec1
Applied Black's 2024 stable style.
https://github.com/psf/black/releases/tag/24.1.0
2024-01-26 12:45:07 +01:00
Nick Pope
500e01073a
Fixed #31262 -- Added support for mappings on model fields and ChoiceField's choices. 2023-08-30 22:57:40 -03:00
Tim Graham
2c4dc64760 Used extlinks for PyPI links.
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2023-04-17 06:55:32 +02:00
JiriKr
cfe563ffaf Fixed #34446 -- Removed unneeded and incorrect example in coding style docs. 2023-03-30 11:06:52 +02:00
django-bot
14459f80ee Fixed #34140 -- Reformatted code blocks in docs with blacken-docs. 2023-03-01 13:03:56 +01:00
Joseph Victor Zammit
ba755ca131 Refs #34140 -- Corrected rst code-block and various formatting issues in docs. 2023-02-28 12:21:37 +01:00
Mariusz Felisiak
ac90529cc5 Fixed docs build with sphinxcontrib-spelling 7.5.0+.
sphinxcontrib-spelling 7.5.0+ includes captions of figures in the set
of nodes for which the text is checked.
2022-05-31 11:17:01 +02:00
Carlton Gibson
ca1c3151c3 Removed versionadded/changed annotations for 4.0. 2022-05-17 14:22:06 +02:00
Vaarun Sinha
fe3518d25e Refs #33476 -- Mentioned black in docs about pre-commit checks. 2022-02-21 06:57:34 +01:00
Carlton Gibson
ba94488196 Refs #33476 -- Adjusted docs and config files for Black.
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2022-02-07 20:36:04 +01:00
Mariusz Felisiak
8b020f2e64
Corrected isort example in coding style docs.
Follow up to e74b3d724e5ddfef96d1d66bd1c58e7aae26fc85.
2021-11-22 12:34:32 +01:00
Paolo Melchiorre
dd528cb2ce
Corrected "pip install" call in coding style docs. 2021-11-22 09:56:56 +01:00
Jacob Walls
f0d0d29f03
Fixed typos in docs. 2021-06-03 07:49:50 +02:00
Jacob Walls
1443b5e9ac
Fixed typo in docs/internals/contributing/writing-code/coding-style.txt. 2021-06-02 08:14:57 +02:00
hashlash
4794a0e35f
Fixed typo in docs/internals/contributing/writing-code/coding-style.txt. 2021-01-09 20:18:00 +01:00
Jon Dufresne
429d089d0a Refs #30367 -- Changed remaining "pip install" to "python -m pip install" in docs. 2020-12-23 17:21:25 +01:00
David Smith
3bca95cca2 Fixed #32165 -- Added pre-commit hooks
* Added pre-commit hooks for isort, flake8 and eslint
* Added documentation on how to install and use the tool
2020-12-23 11:14:48 +01:00
Jon Dufresne
28d998a41c
Updated isort URL to new location. 2020-12-20 11:00:28 +01:00
Carlton Gibson
411cc0ae18 Fixed #29988 -- Updated coding style to allow f-strings.
Thanks to Nick Pope for review.
2020-10-15 10:09:34 +02:00
David Smith
e74b3d724e Bumped minimum isort version to 5.1.0.
Fixed inner imports per isort 5.
isort 5.0.0 to 5.1.0 was unstable.
2020-07-30 10:58:59 +02:00
Nick Pope
fbdb032de2 Used :envvar: role and .. envvar:: directive in various docs. 2020-05-13 09:14:40 +02:00
Mads Jensen
ea44d86ed4 Added guidelines for assertIs() usage. 2019-12-30 11:25:18 +01:00
Jon Dufresne
97d3321e89 Changed tuple choices to list in docs. 2019-05-15 14:31:42 +02:00
Ramiro Morales
aed89adad5 Fixed #30367 -- Changed "pip install" to "python -m pip install" in docs, comments and hints. 2019-04-18 14:41:15 +02:00
Mice Pápai
5a2dd5ec53 Fixed typo in docs/internals/contributing/writing-code/coding-style.txt. 2018-11-02 15:59:12 +01:00
Jon Dufresne
82f286cf6f Refs #29784 -- Switched to https:// links where available. 2018-09-26 08:48:47 +02:00
Jon Dufresne
8c3e0eb1c1 Normalized spelling of "lowercase" and "lowercased". 2018-09-25 10:30:18 -04:00
Curtis Maloney
c49ea6f591 Refs #20910 -- Replaced snippet directive with code-block. 2018-09-10 13:00:34 -04:00
Maxime Lorant
31407fa3b3 Removed duplicate words in docs.
.
2018-07-18 11:24:06 -04:00
Morgan Aubert
704443acac Fixed #29363 -- Added SimpleTestCase.assertWarnsMessage(). 2018-05-09 11:40:28 -04:00
Brett Cannon
64b74804c5 Fixed #29334 -- Updated pypi.python.org URLs to pypi.org. 2018-04-17 20:24:27 -04:00
Ramiro Morales
37c17846ad Fixed #28343 -- Add an OS chooser for docs command line examples. 2018-01-20 12:38:48 -05:00
Mariusz Felisiak
081e787160 Refs #23919 -- Stopped inheriting from object to define new style classes.
Tests and docs complement to cecc079168e8669138728d31611ff3a1e7eb3a9f.
2017-06-26 10:30:31 -04:00
Tim Graham
c68f5d83c0 Fixed #27655 -- Added some guidelines to the coding style docs. 2017-06-12 15:39:09 -04:00
Mikkel Munch Mortensen
1e93210f1f Fixed #27963 -- Removed unneeded docstring example in contributing docs. 2017-03-21 10:12:41 -04:00
Claude Paroz
f3c43ad1fd Refs #23919 -- Removed python_2_unicode_compatible decorator usage 2017-01-18 13:44:34 +01:00
Tim Graham
b5f0b3478d Fixed #27579 -- Added aliases for Python 3's assertion names in SimpleTestCase. 2016-12-07 17:42:31 -05:00
za
321e94fa41 Refs #27392 -- Removed "Tests that", "Ensures that", etc. from test docstrings. 2016-11-10 21:30:21 -05:00