[12.x] Correct use of named argument in Date facade and fix a return type. #54847
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.
Issue #54831
Summary
This PR updates the docblock to correctly reference the named argument usage of
Date::today(timezone: 'UTC')instead ofDate::today(tz: 'UTC'), which throws the following exception:Error: Unknown named parameter $tz.Changes
timezone, aligning withCarbon/Factory, which consistently uses$timezone.Reference: Carbon/Factory.php#L40
Changed it to:
Reference: Carbon/Factory.php#L23