docs: Fix $indexPage param explanations in helpers/html_helper.rst #9162
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix $indexPage parameter explanations in helpers/html_helper.rst
kenjis
reviewed
Sep 5, 2024
| @@ -28,9 +28,9 @@ The following functions are available: | |||
| .. php:function:: img([$src = ''[, $indexPage = false[, $attributes = '']]]) | |||
|
|
|||
| :param string|array $src: Image source URI, or array of attributes and values | |||
| :param bool $indexPage: Whether to treat ``$src`` as a routed URI string | |||
| :param bool $indexPage: Should indexPage be added to the source path | |||
There was a problem hiding this comment.
Is this easier for beginners to understand?
Suggested change
| :param bool $indexPage: Should indexPage be added to the source path | |
| :param bool $indexPage: Should ``Config\App::$indexPage`` be added to the source path |
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fix $indexPage parameter explanations in helpers/html_helper.rst
Checklist: