"Add docstrings to all functions and file headers."
Description
This PR addresses issue #XYZ, which requested the addition of docstrings to the PaymentController.php file to adhere to our coding standards. The changes include:
Added a file header docstring at the beginning of PaymentController.php to describe the purpose and functionality of the file.
Added docstrings to the createSession and handlePaymentSuccess methods. These docstrings provide a brief description of what each method does, the parameters they accept, and the expected return values.
Summary of Changes
app/Http/Controllers/PaymentController.php: Added a file header docstring and method docstrings for createSession and handlePaymentSuccess.
These changes improve the readability of our code and make it easier for developers to understand the purpose and functionality of PaymentController.php and its methods.
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 addresses issue #XYZ, which requested the addition of docstrings to the
PaymentController.php
file to adhere to our coding standards. The changes include:Added a file header docstring at the beginning of
PaymentController.php
to describe the purpose and functionality of the file.Added docstrings to the
createSession
andhandlePaymentSuccess
methods. These docstrings provide a brief description of what each method does, the parameters they accept, and the expected return values.Summary of Changes
app/Http/Controllers/PaymentController.php
: Added a file header docstring and method docstrings forcreateSession
andhandlePaymentSuccess
.These changes improve the readability of our code and make it easier for developers to understand the purpose and functionality of
PaymentController.php
and its methods.