Skip to content

docs: fix misleading deprecation example in versioning guide#229

Merged
dimitri-yatsenko merged 1 commit into
release/docs-2.3.1from
docs/fix-versioning-deprecation-example
Jul 20, 2026
Merged

docs: fix misleading deprecation example in versioning guide#229
dimitri-yatsenko merged 1 commit into
release/docs-2.3.1from
docs/fix-versioning-deprecation-example

Conversation

@dimitri-yatsenko

Copy link
Copy Markdown
Member

The version-deprecated admonition example in about/versioning.md claimed allow_direct_insert is deprecated in favor of dj.config['safemode']. Both claims are incorrect:

  • allow_direct_insert is not deprecated — it is a current insert() parameter (table.py:795, enforced at table.py:830) that guards direct inserts into auto-populated tables outside their make() method.
  • safemode is unrelated — it gates the delete/drop confirmation prompt (table.py:1064/1224), not inserts.

Since this block only illustrates the admonition style, replace it with a generic old_method()/new_method() placeholder so it can't be misread as a factual deprecation claim.

The version-deprecated admonition example claimed `allow_direct_insert`
is deprecated in favor of `dj.config['safemode']`. Both are wrong:
allow_direct_insert is a current insert() parameter (guards direct
inserts into auto-populated tables), and safemode is an unrelated
setting (the delete/drop confirmation prompt). Replace with a generic
old_method()/new_method() placeholder so the style example can't be
read as a factual deprecation claim.
@dimitri-yatsenko dimitri-yatsenko added the documentation Improvements or additions to documentation label Jul 19, 2026
@dimitri-yatsenko
dimitri-yatsenko merged commit cacca13 into release/docs-2.3.1 Jul 20, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants