search

laravel / jetstream

Tailwind scaffolding for the Laravel framework.
https://jetstream.laravel.com
MIT License
3.93k stars 809 forks source link

Update and Add Type Descriptions in PHPDoc Comments #1502

Closed nanato12 closed 1 month ago

nanato12 commented 1 month ago

Overview

There were some incorrect type descriptions and missing type descriptions in the PHPDoc comments within the stubs.

Benefit to End Users

When using static analysis tools such as PHPStan, there is no need to modify the generated files.

Reasons It Does Not Break Any Existing Features

PHPDoc has no effect on the execution of the code itself, so these changes will not impact existing functionality.

Detection with PHPStan

Detection results at level 9

 ------ --------------------------------------------------------------------------------------------------------------------- 
  Line   app/Actions/Jetstream/AddTeamMember.php                                                                              
 ------ --------------------------------------------------------------------------------------------------------------------- 
  59     Method App\Actions\Jetstream\AddTeamMember::rules() return type has no value type specified in iterable type array.  
         💡 See: https://phpstan.org/blog/solving-phpstan-no-value-type-specified-in-iterable-type                            
 ------ --------------------------------------------------------------------------------------------------------------------- 

 ------ ------------------------------------------------------------------------------------------------------------------------------- 
  Line   app/Actions/Jetstream/InviteTeamMember.php                                                                                     
 ------ -------------------------------------------------------------------------------------------------------------------------------                                                                                  
  60     Method App\Actions\Jetstream\InviteTeamMember::rules() return type has no value type specified in iterable type array.         
         💡 See: https://phpstan.org/blog/solving-phpstan-no-value-type-specified-in-iterable-type                                      
 ------ ------------------------------------------------------------------------------------------------------------------------------- 

------ ----------------------------------------------------------------------------------------------------------------------------------------------- 
  Line   app/Models/TeamInvitation.php                                                                                                                  
 ------ ----------------------------------------------------------------------------------------------------------------------------------------------- 
  24     Method App\Models\TeamInvitation::team() return type with generic class Illuminate\Database\Eloquent\Relations\BelongsTo does not specify its  
         types: TRelatedModel, TChildModel                                                                                                              
 ------ -----------------------------------------------------------------------------------------------------------------------------------------------
taylorotwell commented 1 month ago

Thanks for your pull request to Laravel!

Unfortunately, I'm going to delay merging this code for now. To preserve our ability to adequately maintain the framework, we need to be very careful regarding the amount of code we include.

If possible, please consider releasing your code as a package so that the community can still take advantage of your contributions!

If you feel absolutely certain that this code corrects a bug in the framework, please "@" mention me in a follow-up comment with further explanation so that GitHub will send me a notification of your response.