Skip to content
This repository has been archived by the owner on Mar 24, 2021. It is now read-only.

Commit

Permalink
Add in quick Query internals explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
Ralph Cowling committed Jan 29, 2014
1 parent ddd704c commit f50062b
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion backdrop/read/query.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,11 @@ def parse_filter_by(filter_by):

return args


"""
This is the internal Query object
- Create list of attributes to build the query from
- We use delta interally, but the end user will use 'duration'
"""
_Query = namedtuple(
'_Query',
['start_at', 'end_at', 'delta', 'period',
Expand Down

1 comment on commit f50062b

@robyoung
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to give a bit of an explanation of the difference between delta and duration?

The delta describes the duration and the direction of movement (ie. whether we're going back in time or forward in time). This is important for knowing which direction to slide the window when we move the relative date.

Please sign in to comment.