Opened 23 months ago

Closed 23 months ago

Last modified 23 months ago

#20243 closed Bug (fixed)

Related object reference - remove() method

Reported by: john@… Owned by: nobody
Component: Documentation Version: 1.5
Severity: Normal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation:
Needs tests: Patch needs improvement:
Easy pickings: yes UI/UX: no

Description

The documentation for RelatedManager.remove() states:

In order to prevent database inconsistency, this method only exists on ForeignKey objects where null=True.

This statement is misleading as it can be taken to mean that the method only exists for ForeignKey objects for which null is true. I think the statement should read:

For ForeignKey objects, this method only exists if null=True.

The comment about database inconsistency is only stating the obvious.

Change History (2)

comment:1 Changed 23 months ago by Tim Graham <timograham@…>

  • Resolution set to fixed
  • Status changed from new to closed

In 712a7927139e3abf9532d73bc88d35e0ebb3a022:

Fixed #20243 - Clarified when RelatedManager.remove() exists.

comment:2 Changed 23 months ago by Tim Graham <timograham@…>

In 709ee83cd3ccbaeabcfcbb9391bb72d1bcaf01d3:

[1.5.x] Fixed #20243 - Clarified when RelatedManager.remove() exists.

Backport of 712a792713 from master

Note: See TracTickets for help on using tickets.
Back to Top