Opened 6 years ago

Closed 5 years ago

Last modified 4 years ago

#11594 closed (fixed)

Inaccurate docstring for WhereNode.add()

Reported by: garrison Owned by: dwillis
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: UI/UX:

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 dwillis 5 years ago.

Download all attachments as: .zip

Change History (8)

comment:1 Changed 6 years ago by Alex

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset
  • Triage Stage changed from Unreviewed to Accepted

comment:2 Changed 5 years ago by dwillis

  • Owner changed from nobody to dwillis
  • Status changed from new to assigned

Changed 5 years ago by dwillis

comment:3 Changed 5 years ago by dwillis

  • Has patch set
  • milestone set to 1.3
  • Triage Stage changed from Accepted to Ready for checkin

comment:4 Changed 5 years ago by dwillis

  • Component changed from Database layer (models, ORM) to Documentation

comment:5 Changed 5 years ago by lukeplant

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

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

Thanks to garrison for report, dwillis for patch

comment:6 Changed 5 years ago by lukeplant

(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 Changed 4 years ago by jacob

  • milestone 1.3 deleted

Milestone 1.3 deleted

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