- Issue created by @urvashi_vora
- Status changed to RTBC
about 2 years ago 3:18pm 5 May 2023 - ๐ต๐ญPhilippines kenyoOwen
Hi urvashi_vora
I applied patch to the โMedia orientatonโ module and confirmed that the mentioned PHPCS issues are resolved. Please see the screenshots attached.
For your review.
Thank you. - Status changed to Needs work
about 2 years ago 6:47pm 5 May 2023 - ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
+/** + * @file + * Module file. + */
The description for a module file is Hook implementations for the Media orientation module. (in this specific case).
+ /** + * Entity Query. + * + * @var \Drupal\Core\Entity\Query\QueryFactory
Only the first word in the description must be capitalized.
+ /** + * The Get EntityTypeManagerInterface. + * + * @var \Drupal\Core\Entity\EntityTypeManagerInterface + */ + protected $entityTypeManager;
That is The entity type manager.
+ /** + * Constructs object. + * + * @param \Drupal\Core\Entity\Query\QueryFactory $entityQuery
Description for constructors starts with Constructs a new (the trailing space is included) followed by the class name (namespace included) and ends with object. (The space before object and the period after object are included.)
+ * Query Factory. + * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager + * Entity Manager Interface.
Only the first word in a description must be capitalized.
It is The entity type manager.* @param \Drupal\Core\Entity\EntityInterface $entity - * - * @return void + * Entity Interface.
The @return line is missing.
The description is too generic. Also, a return value cannot be an interface; it can eventually be an object that implements an interface, but there is not anEntity
interface. - Assigned to imustakim
- Issue was unassigned.
- Status changed to Needs review
about 2 years ago 8:23am 8 May 2023 - ๐จ๐ฆCanada imustakim Canada
Patch updated as per #3 suggestions.
Only error remaining is exceeding 80 characters in line, because of the constructor description containing class namespace.
Assuming this cane be ignored.Please review.