Clarifying comment

joedolson · joedolson · commit 4384f39580b0 · 2024-07-15T16:02:35.000-05:00
diff --git a/src/my-calendar-events.php b/src/my-calendar-events.php
@@ -687,7 +687,7 @@ function mc_get_nearest_event( $id, $next = false ) {
 }
 
 /**
- * Returns the event object for a specific instance of an event.
+ * Returns the event object for a specific instance of an event. Use mc_get_first_event() if the instance ID is unknown.
  *
  * @param int    $id  Event instance ID.
  * @param string $type  'object' or 'html'.

Original file line number	Diff line number	Diff line change
`@@ -687,7 +687,7 @@ function mc_get_nearest_event( $id, $next = false ) {`
`687`	`687`	`}`
`688`	`688`
`689`	`689`	`/**`
`690`		`- * Returns the event object for a specific instance of an event.`
	`690`	`+ * Returns the event object for a specific instance of an event. Use mc_get_first_event() if the instance ID is unknown.`
`691`	`691`	`*`
`692`	`692`	`* @param int $id Event instance ID.`
`693`	`693`	`* @param string $type 'object' or 'html'.`