Add Docstrings and File Headers

liberu-real-estate / real-estate-laravel

Estate agency application written in Laravel 11 / PHP 8.3 using Filament 3

23 stars 5 forks source link

PR Feedback (click)

[ ] 👍 Sweep Did Well
[ ] 👎 Sweep Needs Improvement
I created this PR to address this rule:

"Add docstrings to all functions and file headers."

Description

This PR adds docstrings to all functions and file headers in the following files:
app/Filament/Resources/BranchResource.php
app/Filament/Resources/BranchResource/Pages/CreateBranch.php
app/Filament/Resources/BranchResource/Pages/EditBranch.php
app/Filament/Resources/BranchResource/Pages/ListBranches.php
app/Models/Branch.php
app/Providers/Filament/AdminPanelProvider.php
database/migrations/2023_04_01_000000_create_branches_table.php

The docstrings provide a clear description of the purpose and functionality of each file and function, improving code readability and maintainability.

Summary of Changes

Added a PHPDoc block at the beginning of each PHP file to serve as the file header.
Added PHPDoc blocks above each function in the PHP files, describing the purpose, inputs, and outputs of the functions.
Added a comment block at the beginning of the migration file and above the up and down methods.

Rollback Files For Sweep

[ ] Rollback changes to app/Filament/Resources/BranchResource.php

[ ] Rollback changes to app/Filament/Resources/BranchResource/Pages/CreateBranch.php

[ ] Rollback changes to app/Filament/Resources/BranchResource/Pages/EditBranch.php

[ ] Rollback changes to app/Filament/Resources/BranchResource/Pages/ListBranches.php

[ ] Rollback changes to app/Models/Branch.php

[ ] Rollback changes to app/Providers/Filament/AdminPanelProvider.php

[ ] Rollback changes to database/migrations/2023_04_01_000000_create_branches_table.php

liberu-real-estate / real-estate-laravel