From 7188cf7926c70680058f384ede96e5af5e0ccfee Mon Sep 17 00:00:00 2001
From: Caen De Silva <caen@desilva.se>
Date: Fri, 26 Jul 2024 18:50:15 +0200
Subject: [PATCH] Improve helper function documentation

---
 packages/framework/src/helpers.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/packages/framework/src/helpers.php b/packages/framework/src/helpers.php
index 743fffb8efd..14e69878d67 100644
--- 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
             {