docs: fix example for multiple tags in cacheTag usage #75693
Merged
+1
−1
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
The documentation for the `cacheTag` function incorrectly showed multiple tags being passed as separate arguments. However, `cacheTag` expects an array of tags. This update corrects the example by passing the tags as an array.
- Changed the example from `cacheTag('tag-one', 'tag-two')` to `cacheTag(['tag-one', 'tag-two'])`.
- Clarified that multiple tags should be passed as an array to avoid confusion.
This change improves clarity for developers using the `cacheTag` function.
|
Allow CI Workflow Run
Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer |
1 similar comment
|
Allow CI Workflow Run
Note: this should only be enabled once the PR is ready to go and can only be enabled by a maintainer |
leerob
approved these changes
Feb 5, 2025
@leerob I might be missing something but I'm not sure this change was correct. |
Merged
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.
The documentation for the
cacheTagfunction incorrectly showed multiple tags being passed as separate arguments. However,cacheTagexpects an array of tags. This update corrects the example by passing the tags as an array.cacheTag('tag-one', 'tag-two')tocacheTag(['tag-one', 'tag-two']).This change improves clarity for developers using the
cacheTagfunction.