- Issue created by @sonam_sharma
- Status changed to Needs work
over 1 year ago 9:38am 3 July 2023 - ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
+/** + * @file + * Module file. + */
The usual description is Hook implementations for the [module name] module. where [module name] is the module name shown in the .info.yml file.
- Assigned to anchal_gupta
- Issue was unassigned.
- Status changed to Needs review
over 1 year ago 10:06am 3 July 2023 - Status changed to Needs work
over 1 year ago 10:50am 3 July 2023 - ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
It is Hook implementations for the Stripe Pay module.
- Status changed to Needs review
over 1 year ago 5:46am 4 July 2023 - Status changed to Needs work
over 1 year ago 7:28am 4 July 2023 - ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
Actually, let us rescope this issue. There are many documentation comments that need to be fixed.
- ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
The documentation comment for the .module file is missing. Furthermore, there are other documentation comments that are incomplete or need to be fixed. For example:
/** * Get currency codes available on the stripe */ function stripe_currency_codes()
It does not describe the return value. The verb used in the description needs to be declined on the third person singular.
/** * Price format */ function stripe_price_formats($currency_code, $currency_sign)
It does not describe the parameters nor the return value.
/** * Log messages on the system * @param $log_type type of the error message * @param $message message body * @return */ function log_stripe_pay_messages($log_type, $message)
The documentation comment is not correctly formatted. The verb used in the description needs to be declined on the third person singular.
/** * Plugin implementation of the 'stripe_payment' field type. * * @FieldType( * id = "stripe_payment", * label = @Translation("Stripe Payment"), * category = @Translation("Stripe Payment"), * default_widget = "stripe_payment_default_widget", * default_formatter = "stripe_payment_default_formatter" * ) */ class StripePaymentFieldItem extends FieldItemBase implements FieldItemInterface {
The documentation comment is not correctly formatted.
- Status changed to Needs review
over 1 year ago 10:16am 3 November 2023 - ๐ฎ๐ณIndia subhashuyadav Mumbai
Updated patch with the above mentioned changes.
- Status changed to Fixed
26 days ago 1:57am 28 January 2025 - ๐ณ๐ตNepal sujan shrestha Kathmandu๐ณ๐ต, Nepal
Thank you for the feedback, and I apologize for the delayed response. Iโve reviewed the feedback and the patch, and Iโve made the necessary changes to the documentation comments for the files, classes, functions, and methods. The issues have now been fixed.
Automatically closed - issue fixed for 2 weeks with no activity.