Opened 15 years ago

Closed 14 years ago

Last modified 13 years ago

#11594 closed (fixed)

Inaccurate docstring for WhereNode.add()

Reported by: Jim Garrison Owned by: Derek Willis
Component: Documentation Version: 1.1-beta
Severity: Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

r9700 changed the interface for WhereNode.add(), but it did not update the function's docstring to reflect the change.

The docstring currently says:

        """
        Add a node to the where-tree. If the data is a list or tuple, it is
        expected to be of the form (alias, col_name, field_obj, lookup_type,
        value), which is then slightly munged before being stored (to avoid
        storing any reference to field objects). Otherwise, the 'data' is
        stored unchanged and can be anything with an 'as_sql()' method.
        """

As of r9700, if data is a list or tuple, it is actually expected to be of the form (obj, lookup_type, value), where obj is a Constraint object.

Attachments (1)

11594.diff​ (1.4 KB ) - added by Derek Willis 14 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 by Alex Gaynor, 15 years ago

Triage Stage: Unreviewed → Accepted

comment:2 by Derek Willis, 14 years ago

Owner: changed from nobody to Derek Willis
Status: new → assigned

by Derek Willis, 14 years ago

Attachment: 11594.diff​ added

comment:3 by Derek Willis, 14 years ago

Has patch: set
milestone: → 1.3
Triage Stage: Accepted → Ready for checkin

comment:4 by Derek Willis, 14 years ago

Component: Database layer (models, ORM) → Documentation

comment:5 by Luke Plant, 14 years ago

Resolution: → fixed
Status: assigned → closed

(In [13843]) Fixed #11594 - Inaccurate docstring for WhereNode.add()

Thanks to garrison for report, dwillis for patch

comment:6 by Luke Plant, 14 years ago

(In [13844]) [1.2.X] Fixed #11594 - Inaccurate docstring for WhereNode.add()

Thanks to garrison for report, dwillis for patch

Backport of [13843] from trunk

comment:7 by Jacob, 13 years ago

milestone: 1.3

Milestone 1.3 deleted

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