summaryrefslogtreecommitdiff
path: root/docs/internals
AgeCommit message (Collapse)Author
2025-09-13Refs #35667 -- Corrected usage of skip_file_prefixes in contributing docs.Clifford Gama
2025-09-12Refs #35667 -- Updated contributing guide to use django_file_prefixes on ↵nessita
deprecations.
2025-08-28Ensured :doc: role uses absolute targets in docs.Adam Johnson
2025-08-28Replaced :doc: role usage with :ref: when appropriate in docs.Natalia
2025-08-28Fixed #36570 -- Removed unnecessary :py domain from documentation roles.SaJH
Signed-off-by: SaJH <wogur981208@gmail.com>
2025-08-27Fixed #36572 -- Revert "Fixed #36546 -- Deprecated ↵Sarah Boyce
django.utils.crypto.constant_time_compare() in favor of hmac.compare_digest()." This reverts commit 0246f478882c26bc1fe293224653074cd46a90d0.
2025-08-26Clarified Trac "version" attribute in contributing guide.Jacob Walls
2025-08-26Corrected definition of "needsinfo" triage stage in contributing guide.Jacob Walls
2025-08-25Fixed #36485 -- Added lint-docs check in Tox and GitHub Actions.David Smith
The `check` docs target now runs spelling, black, and lint, so all current documentation quality checks can be run with a single command. Also documented the lint-docs check's availability and usage.
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-25Refs #36485 -- Removed double spaces after periods in sentences.Natalia
2025-08-25Refs #36485 -- Fixed dangling hyphen and unbalanced inline markup in docs.David Smith
2025-08-25Refs #36485 -- Removed unnecessary parentheses in :meth: and :func: roles in ↵David Smith
docs.
2025-08-25Fixed #36546 -- Deprecated django.utils.crypto.constant_time_compare() in ↵SaJH
favor of hmac.compare_digest(). Signed-off-by: SaJH <wogur981208@gmail.com>
2025-08-23Removed reference to flake8 file exclusions.Jacob Walls
Obsolete since 41384812efe209c8295a50d78b45e0ffb2992436. (six was removed in 9285926295fbfc86b70e7be8d595d4cfbe7895b8.)
2025-08-22Refs #35530 -- Corrected deprecation message in auth.alogin().Mariusz Felisiak
Follow up to ceecd518b19044181a3598c55ebed7c2545963cc.
2025-08-05Refs #36485 -- Grouped docs checks under a unified make check target.David Smith
Added a new 'check' rule to the docs Makefile which runs both the black and spelling checks.
2025-08-05Refs #34140 -- Added dedicated code block formatting section in ↵David Smith
docs/internals/contributing/writing-documentation.txt.
2025-07-28Moved manual testing instructions from intro to submitting patches docs.Jordan Bae
The section on manual testing, including how to use a local checkout of Django, is moved from the contribution intro to the submitting patches docs. This makes it easier for reviewers and authors to follow best practices.
2025-07-25Fixed #35581 -- Updated django.core.mail to Python's modern email API.Mike Edmunds
- Changed EmailMessage.message() to construct a "modern email API" email.message.EmailMessage and added policy keyword arg. - Added support for modern MIMEPart objects in EmailMessage.attach() (and EmailMessage constructor, EmailMessage.attachments list). - Updated SMTP EmailBackend to use modern email.policy.SMTP. Deprecated: - Attaching MIMEBase objects (replace with MIMEPart) - BadHeaderError (modern email uses ValueError) - SafeMIMEText, SafeMIMEMultipart (unnecessary for modern email) - django.core.mail.forbid_multi_line_headers() (undocumented, but exposed via `__all__` and in wide use) - django.core.mail.message.sanitize_address() (undocumented, but in wide use) Removed without deprecation (all undocumented): - EmailMessage.mixed_subtype - EmailMultiAlternatives.alternative_subtype - Support for setting (undocumented) EmailMessage.encoding property to a legacy email.charset.Charset object Related changes: - Dropped tests for incorrect RFC 2047 encoding of non-ASCII email address localparts. This is specifically prohibited by RFC 2047, and not supported by any known MTA or email client. (Python still mis-applies encoded-word to non-ASCII localparts, but it is a bug that may be fixed in the future.) - Added tests that try to discourage using Python's legacy email APIs in future updates to django.core.mail.
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-07-23Added accessibility guidelines for contributors.Thibaud Colas
2025-07-17Fixed #36163 -- Deprecated most positional arguments in django.core.mail.Mike Edmunds
In public mail APIs, changed less frequently used parameters from keyword-or-positional to keyword-only, emitting a warning during the required deprecation period.
2025-07-16Fixed #36477, Refs #36163 -- Added @deprecate_posargs decorator to simplify ↵Mike Edmunds
deprecation of positional arguments. This helper allows marking positional-or-keyword parameters as keyword-only with a deprecation period, in a consistent and correct manner.
2025-07-13Added Django ecosystem page to the documentation.Tim Schilling
2025-07-09Updated asgiref dependency.Carlton Gibson
2025-06-27Fixed indentation in docs/internals/howto-release-django.txt.Sarah Boyce
2025-06-27Separated creating the release and setting it as default in Trac in the ↵Sarah Boyce
post-release steps.
2025-06-20Fixed #36152 -- Deprecated use of "%" in column aliases.Jacob Walls
Unintentional support existed only on SQLite and Oracle.
2025-06-18Clarified that only latest dependency versions are valid for security reports.Jake Howard
2025-06-17Added guidance on AI-assisted security reports to docs/internals/security.txt.nessita
Co-authored-by: Shai Berger <shai@platonix.com> Co-authored-by: Mike Edmunds <medmunds@gmail.com>
2025-05-23Fixed #36390 -- Deprecated RemoteUserMiddleware subclasses missing ↵Sarah Boyce
aprocess_request(). Regression in 50f89ae850f6b4e35819fe725a08c7e579bfd099. Thank you to shamoon for the report and Natalia Bidart for the review.
2025-05-13Updated guidance to propose new feature ideas in contributing docs.Lily Foote
These changes include: * Clarification of the new feature proposal and evaluation process. * Reodering "points to consider" into reporting bugs section, since these are mostly trac-specific. * Narrowing the guide on user interface bugs and features to just bugs. * Updating documentation for Someday/Maybe triage stage. Co-authored-by: Tim Schilling <schilling711@gmail.com> Co-authored-by: Sarah Boyce <42296566+sarahboyce@users.noreply.github.com> Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>
2025-05-06Simplified artifact building steps in docs/internals/howto-release-django.txt.Natalia
With the recent merge of artifact build updates from https://github.com/django/django/pull/19436, there is no need to have different build instructions for 4.2.
2025-04-15Fixed #36311 -- Unified spelling of "hardcode" and its variants in docs.Ahmed Nassar
Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>
2025-04-04Added usage for `--since` when fetching translations in ↵Natalia
docs/internals/howto-release-django.txt.
2025-03-31Fixes #36215 -- Included unpacking generalization notes in coding style ↵Aarni Koskela
guide (PEP-448).
2025-03-25Fixed #35452 -- Deprecated orphans being more than or equal to page_size in ↵wookkl
pagination.
2025-03-21Documented the updating of translation catalogs in post-release tasks.Sarah Boyce
Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>
2025-03-21Fixed #36138 -- Changed ADMINS and MANAGERS settings to lists of strings.Mike Edmunds
Previously, the ADMINS and MANAGERS settings were lists of (name, address) tuples (where the name had been unused). Deprecated use of tuples. Updated settings value sanity checks, and changed from ValueError to ImproperlyConfigured.
2025-03-19Fixed #36000 -- Deprecated HTTP as the default protocol in urlize and ↵Ahmed Nassar
urlizetrunc.
2025-03-18Refs #35980 -- Updated internal docs for artifact upload and release via ↵Baptiste Mispelon
admin site. Recent updates to djangoproject.com extended the `Release` model to support uploading and storing artifacts and checksum files. This branch updates the "How to release Django" docs to match the new release flow.
2025-03-03Refs #35444 -- Deprecated contrib.postgres.OrderableAggMixin.Chris Muthig
This commit does not create any functional changes, but marks the existing `OrderableAggMixin` class as deprecated so that developers using it directly can be made aware of its future removal.
2025-03-03Fixed #35444 -- Added generic support for Aggregate.order_by.Chris Muthig
This moves the behaviors of `order_by` used in Postgres aggregates into the `Aggregate` class. This allows for creating aggregate functions that support this behavior across all database engines. This is shown by moving the `StringAgg` class into the shared `aggregates` module and adding support for all databases. The Postgres `StringAgg` class is now a thin wrapper on the new shared `StringAgg` class. Thank you Simon Charette for the review.
2025-02-24Added security guideline on reasonable size limitations when rendering ↵Sarah Boyce
content via the DTL. This also removes the need to add warnings for every Django template filter.
2025-02-24Added security reporting guidelines.Sarah Boyce
2025-02-24Updated expectations for when security reports will receive a reply.Sarah Boyce
2025-02-19Fixed #35908 -- Retired the django-developers and django-users mailing lists.Sarah Boyce
Co-authored-by: Chaitanya Rahalkar <chaitanyarahalkar@squareup.com>
2025-02-16Refs #35967 -- Deprecated BaseDatabaseCreation.create_test_db(serialize).Simon Charette
Given there are no longer any internal usages of serialize=True and it poses a risk to non-test databases integrity it seems appropriate to deprecate it.
2025-02-10Specified "django" repository for twine call in ↵Mariusz Felisiak
docs/internals/howto-release-django.txt. It's necessary to specify a repository for `.pypirc` user configurations with multiple per-project PyPI tokens. Follow up to 26aedbbc0835df83140c7424df62bda03382f598.
generated by cgit v1.3 (git 2.53.0) at 2026-07-03 21:06:47 +0000