Document event parameter (#172)

Author: edalzell

DOCUMENTATION.md

@@ -198,7 +198,8 @@ sort="desc"
 Returns events within a date range.
 
 **Parameters:**
-- `collection` (optional)
+- `collection` (optional, defaults to 'events')
+- `event` (optional) Pass `id` of the event you want occurrences for
 - `from` (optional, defaults to now)
 - `to` (required)
 
@@ -219,6 +220,10 @@ Additional flags:
 
 Returns events within a future time window.
 
+**Parameters:**
+- `collection` (optional, defaults to 'events')
+- `event` (optional) Pass `id` of the event you want occurrences for
+
 Example:
 
 ```antlers
@@ -229,24 +234,29 @@ next="90 days"
 
 Returns events occurring today.
 
-Optional:
-- `ignore_past="true"`
+**Parameters:**
+- `collection` (optional, defaults to 'events')
+- `event` (optional) Pass `id` of the event you want occurrences for
+- `ignore_past` (optional, defaults to 'false')
 
 ### events:upcoming
 
 Returns the next set of event occurrences.
 
 **Parameters:**
 - `limit` (required)
-- `collection` (optional)
-- `event` (optional)
+- `collection` (optional, defaults to 'events')
+- `event` (optional) Pass `id` of the event you want occurrences for
 - `collapse_multi_days` (optional)
 - `offset` (optional)
 
 ### events:download_link
 
 Generates an ICS download link.
 
+**Parameters:**
+- `date` date get occurrences to download
+
 Includes:
 - `location`
 - `description`

tests/Tags/EventsTest.php

@@ -27,6 +27,22 @@
     $this->tag = app(EventsTag::class);
 });
 
+test('can generate between occurrences of a specific event', function () {
+    Carbon::setTestNow(now()->setTimeFromTimeString('10:00'));
+
+    $this->tag
+        ->setContext([])
+        ->setParameters([
+            'event' => 'recurring-event',
+            'from' => Carbon::now(),
+            'to' => Carbon::now()->addWeek(3),
+        ]);
+
+    $occurrences = $this->tag->between();
+
+    expect($occurrences)->toHaveCount(4);
+});
+
 test('can generate between occurrences', function () {
     Carbon::setTestNow(now()->setTimeFromTimeString('10:00'));