Skip to content

Commit 3b53809

Browse files
authoredJan 4, 2020
Merge pull request #86 from zacharywelch/patch-1
Add table headers
2 parents ad164da + f83cec3 commit 3b53809

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed
 

‎README.md

+3
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ class MyModel
4444
ByStar adds the following finder scopes (class methods) to your model to query time ranges.
4545
These accept a `Date`, `Time`, or `DateTime` object as an argument, which defaults to `Time.zone.now` if not specified:
4646

47+
| Scope | Meaning |
4748
| --- | --- |
4849
| `between_times(start_time, end_time)` | Finds all records occurring between two given times. |
4950
| `between_dates(start_date, end_date)` | Finds all records occurring between two given dates, from beginning of start_date until end of end_date. |
@@ -62,6 +63,7 @@ These accept a `Date`, `Time`, or `DateTime` object as an argument, which defaul
6263
ByStar adds additional shortcut scopes based on commonly used time ranges.
6364
See sections below for detailed argument usage of each:
6465

66+
| Scope | Meaning |
6567
| --- | --- |
6668
| `by_day` | Query by a given date. |
6769
| `by_week` | Allows zero-based week value from 0 to 52. |
@@ -79,6 +81,7 @@ ByStar also adds scopes which are relative to the current time.
7981
Note the `past_*` and `next_*` methods represent a time distance from current time (`Time.zone.now`),
8082
and do not strictly end/begin evenly on a calendar week/month/year (unlike `by_*` methods which do.)
8183

84+
| Scope | Meaning |
8285
| --- | --- |
8386
| `today` | Finds all occurrences on today's date. |
8487
| `yesterday` | Finds all occurrences on yesterday's date. |

0 commit comments

Comments
 (0)
Please sign in to comment.