Improve helper function documentation

hydephp · Jul 26, 2024 · 7188cf7 · 7188cf7
1 parent b6f4572
commit 7188cf7
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/packages/framework/src/helpers.php b/packages/framework/src/helpers.php
@@ -46,7 +46,7 @@ function asset(string $name, bool $preferQualifiedUrl = false): string
 
         if (! function_exists('route')) {
             /**
-             * Get a page route by its key.
+             * Get a page route instance by its key. Casting it to a string will return a relative link to the page.
              */
             function route(string $key): ?Hyde\Support\Models\Route
             {