Skip to content

Commit b26bb18

Browse files
committed
Improve and normalize method documentation
1 parent 3068bfb commit b26bb18

File tree

2 files changed

+7
-4
lines changed

2 files changed

+7
-4
lines changed

packages/framework/src/Foundation/Kernel/Hyperlinks.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,10 @@ public function mediaLink(string $destination, bool $validate = false): string
103103
}
104104

105105
/**
106-
* Gets a relative web link to the given image stored in the _site/media folder.
107-
* If the image is remote (starts with http) it will be returned as is.
106+
* Gets a relative web link to the given file stored in the `_site/media` folder.
107+
* If the image is already qualified (starts with `http`) it will be returned as is.
108108
*
109-
* If a base URL is set, the image will be returned with a qualified absolute URL.
109+
* If a base URL is configured, the image will be returned with a qualified absolute URL.
110110
*/
111111
public function asset(string $name): string
112112
{

packages/framework/src/helpers.php

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,10 @@ function hyde(): HydeKernel
2020
} else {
2121
if (! function_exists('asset')) {
2222
/**
23-
* Get a relative link or URL to an asset in the media directory.
23+
* Gets a relative web link to the given file stored in the `_site/media` folder.
24+
* If the image is already qualified (starts with `http`) it will be returned as is.
25+
*
26+
* If a base URL is configured, the image will be returned with a qualified absolute URL.
2427
*/
2528
function asset(string $name): string
2629
{

0 commit comments

Comments
 (0)