- Issue created by @himanshu_jhaloya
- @himanshu_jhaloya opened merge request.
- Issue was unassigned.
- Status changed to Needs review
about 1 year ago 10:07am 2 May 2023 - Status changed to Needs work
about 1 year ago 11:27am 2 May 2023 - ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
/** - * Class AparatApi + * Class of AparatApi. */
A class short description must not start with Class of nor repeat the class name.
/** + * Logger channel interface. + * * @var \Drupal\Core\Logger\LoggerChannel */ protected LoggerChannel $logger;
There is a missing article. interface is not necessary and it is wrong, since a property cannot contain an interface.
Each description is missing an article. Since that documentation comment is edited, the constructor description needs to be changed too. <code> /** - * get Video info from video hash + * Get Video info from video hash. * * @param string $hash - * The vide hash + * The vide hash. * * @return array|bool + * Return array. */ public function getVideoInfo(string $hash) {
In the short description, the verb must use the third person singular.
vide is a typo.
The return value description must describe the return value, not its type.try { - $resource_url = $this->urlResolver->getResourceUrl($url); - $this->resourceFetcher->fetchResource($resource_url); + $resource_url = $this->urlResolver->getResourceUrl($url); + $this->resourceFetcher->fetchResource($resource_url); }
The code is already correctly indented, contrary to the changed code.
/** + * Third party api. + * * @var \Drupal\media_aparat\AparatApi */
api is misspelled.
That description is too vague.- * @param \Drupal\media_aparat\AparatApi $aparat_api + * @param \Drupal\media_aparat\AparatApi $aparatApi + * The third party api. * @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory + * The logger service. */
Local variables, which include also method parameters, are allowed to follow that naming schema.
/** - * Prevent usage of this field formatter on any fields other than those which are added in - * a media type which it's source is AparatVideo + * Prevent usage of this field formatter on any fields other than. + * + * Those which are added in a media type which it's source is AparatVideo.
Prevent usage of this field formatter on any fields other than. alone is not a sentence.
Those which are added in a media type which it's source is AparatVideo. does not make any sense and it is not grammatically correct.
The existing description must be fixed, but the changed description is not the way to correct it./** - * Prevent usage of this field widget on any fields other than those which are added in - * a media type which it's source is AparatVideo + * Prevent usage of this field widget on any fields other than . + * + * Those which are added in a media type which it's source is AparatVideo. */
Ditto.
/** - * The Aparat Api + * The Aparat Api. + * + * @var \Drupal\media_aparat\AparatApi */ protected AparatApi $aparatApi;
Api is misspelled.
- ๐ฎ๐ณIndia Ashutosh Ahirwal India
Ashutosh Ahirwal โ made their first commit to this issueโs fork.
- Status changed to Needs review
about 1 year ago 12:13pm 22 June 2023 - ๐ฎ๐ณIndia Ashutosh Ahirwal India
Hi I have addressed #5 comment and updated the MR
Please review. - ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
(Fixing code that does not follow the Drupal coding standards is a task.)
- Status changed to Needs work
about 1 year ago 12:28pm 22 June 2023 - Assigned to nitin_lama
- ๐ฎ๐ณIndia kbk1992 Hyderabad
bharath-kondeti โ made their first commit to this issueโs fork.
- Issue was unassigned.
- Status changed to Needs review
4 months ago 8:31am 15 February 2024