Skip to content

Commit 71dd1b6

Browse files
committed
Small improvements to Readme
1 parent 85f3c99 commit 71dd1b6

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# django-range-merge
22

3-
Enables the range_merge Aggregate for Django on Postgres. It should only be used with Django projects using the Postgres database.
3+
Enables the `range_merge` Aggregate for Django on Postgres. It should only be used with Django projects using the Postgres database. See [Postgres docs on Range Functions](https://www.postgresql.org/docs/14/functions-range.html#RANGE-FUNCTIONS-TABLE).
44

5-
Note: This app is still a work-in-progress, but *should* be functional. Tests have not yet been implemented.
5+
Note: This app is still a work-in-progress, but currently works. Tests have not yet been implemented.
66

77

88
## Installing
@@ -79,7 +79,7 @@ def range_of_visitors_this_month(request):
7979
context = Event.objects.filter(period__overlaps=get_month_range()).aggregate(
8080
output=Aggregate(F("potential_visitors"), function="range_merge")
8181
)
82-
# {'output': NumericRange(3, 20, '[)')}
82+
# example result: {'output': NumericRange(3, 20, '[)')}
8383
8484
return TemplateResponse(request, template, context)
8585
@@ -89,7 +89,7 @@ def overall_dates_of_funded_events(request):
8989
context = Event.objects.filter(is_funded=True).aggregate(
9090
output=Aggregate(F("period"), function="range_merge")
9191
)
92-
# {'output': DateTimeRange("2022-10-01", "2022-12-07", '[)')}
92+
# example result: {'output': DateTimeRange("2022-10-01", "2022-12-07", '[)')}
9393
9494
return TemplateResponse(request, template, context)
9595

0 commit comments

Comments
 (0)