Inaccurate docstring for WhereNode.add()
|Reported by:||Jim Garrison||Owned by:||Derek Willis|
|Cc:||Triage Stage:||Ready for checkin|
|Has patch:||yes||Needs documentation:||no|
|Needs tests:||no||Patch needs improvement:||no|
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
Change History (8)
comment:3 Changed 7 years ago by
|Triage Stage:||Accepted → Ready for checkin|