Update outdated docblock for od_url_metric_freshness_ttl filter

ShyamGadde · ShyamGadde · commit fe8f28249684 · 2025-03-18T10:10:20.000+05:30
Signed-off-by: Shyamsundar Gadde &lt;shyamsundar.gadde@rtcamp.com&gt;
diff --git a/plugins/optimization-detective/storage/data.php b/plugins/optimization-detective/storage/data.php
@@ -26,7 +26,11 @@ function od_get_url_metric_freshness_ttl(): int {
 	/**
 	 * Filters the freshness age (TTL) for a given URL Metric.
 	 *
-	 * The freshness TTL must be at least zero, in which it considers URL Metrics to always be stale.
+	 * The freshness TTL can be:
+	 * - Zero: URL Metrics are always considered stale based on timestamp
+	 * - Positive: URL Metrics older than this value (in seconds) are considered stale
+	 * - Negative: Timestamp-based staleness checks are disabled, relying solely on ETag changes
+	 *
 	 * In practice, the value should be at least an hour.
 	 *
 	 * @since 0.1.0

Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,11 @@ function od_get_url_metric_freshness_ttl(): int {`
`26`	`26`	`/**`
`27`	`27`	`* Filters the freshness age (TTL) for a given URL Metric.`
`28`	`28`	`*`
`29`		`- * The freshness TTL must be at least zero, in which it considers URL Metrics to always be stale.`
	`29`	`+ * The freshness TTL can be:`
	`30`	`+ * - Zero: URL Metrics are always considered stale based on timestamp`
	`31`	`+ * - Positive: URL Metrics older than this value (in seconds) are considered stale`
	`32`	`+ * - Negative: Timestamp-based staleness checks are disabled, relying solely on ETag changes`
	`33`	`+ *`
`30`	`34`	`* In practice, the value should be at least an hour.`
`31`	`35`	`*`
`32`	`36`	`* @since 0.1.0`