- Issue created by @urvashi_vora
- Status changed to Needs work
over 1 year ago 12:46pm 19 May 2023 - 🇮🇹Italy apaderno Brescia, 🇮🇹
- * Class CheckAgentServices. + * Implements CheckAgentServicesInterface for CheckAgentServices.
Class descriptions must not start with
Implements
and then repeat the class name and the interface name. That information is already given from the code. What descriptions should do is describing the class purpose or what the class does./** - * Interface CheckAgentServicesInterface. + * Check Agent Services Interface.
That is still repeating the interface name, even if spaces have been added.
/** - * Class CheckUserAgentController. + * Controller for CheckUserAgentController. */
That description is still repeating the class name.
- 🇮🇳India urvashi_vora Madhya Pradesh, India
Thanks for the feedback will provide a patch asap.
- Status changed to Needs review
over 1 year ago 3:25am 22 May 2023 - 🇮🇳India urvashi_vora Madhya Pradesh, India
Providing the updated patch with suggestions of #2. Please review.
Thanks - Status changed to Needs work
over 1 year ago 7:45am 22 May 2023 - 🇮🇹Italy apaderno Brescia, 🇮🇹
/** - * Class CheckAgentServices. + * Service for Checking user agents. */
Only the first word in the description must be capitalized.
- * Class UserAgentSubscriber. + * Implements EventSubscriberInterface for UserAgentSubscriber.
The description must say what the class purpose is, not which interfaces are implemented by the class or the class name.
/** - * Class DeviceEntityForm. + * Entity Form for DeviceEntityForm. */
/** - * Class UserAgentEntityForm. + * Entity Form for UserAgentEntityForm. */
If those are entity form classes, for should be followed by the entity for which those forms are built.
/** - * Class ProvideForm. + * Provide Form. */ class ProvideForm extends ConfigFormBase {
That is still repeating the class name, except a space has been put in the middle of the class name. That description does not say what the class does. (Hint: It extends
ConfigFormBase
.) - Assigned to urvashi_vora
- 🇮🇳India urvashi_vora Madhya Pradesh, India
I will provide a patch asap. Assigning it to myself.
Thanks
- Issue was unassigned.
- Status changed to Needs review
over 1 year ago 4:15am 23 May 2023 - 🇮🇳India urvashi_vora Madhya Pradesh, India
Please review the updated patch. Thanks
- 🇺🇦Ukraine artsays
Thank you for your contribution and for fixing class names.
The issue also appeared with ordering in Uses namespaces.
Attached patch and combining with fixes for both issues. - Status changed to Fixed
9 months ago 10:24am 17 February 2024 - Status changed to Fixed
9 months ago 10:24am 17 February 2024