- Issue created by @Harsh
- Status changed to Needs review
about 1 year ago 1:12pm 19 October 2023 - ๐ฎ๐ณIndia Harsh
I have fixed the phpcs issues.Please review the patch
- Status changed to Needs work
about 1 year ago 1:26pm 19 October 2023 - ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
+ /** + * The form builder service. + * + * @var \Drupal\Core\Form\FormBuilderInterface
The form builder. is sufficient.
+ /** + * FilterEntityTypesController constructor. + * + * @param \Drupal\Core\Form\FormBuilderInterface $formBuilder + * The form builder service. + */ + public function __construct(FormBuilderInterface $formBuilder) {
The documentation comment for constructors is not mandatory anymore, If it is given, the description must be Constructs a new [class name] object. where [class name] includes the class namespace.
- * @return The `content()` function is returning a Drupal form object generated by the `getForm()` - * method of the `Drupal\formBuilder()` service. The form being returned is + * @return \Drupal\Core\Form\FormInterface + * A Drupal form object generated by the `getForm()` method + * of the `Drupal\formBuilder()` service. The form being returned is * an instance of the `FilterEntityTypesForm` form defined in the * `Drupal\entitytype_filter\Form` namespace.
Code shown in documentation comments is not quoted with
`
.+ /** + * Creates an instance of the FilterFieldTypesController class. + * + * @param \Symfony\Component\DependencyInjection\ContainerInterface $container + * The service container. + * + * @return static + * A new instance of the FilterFieldTypesController class. + */
The documentation comment for a method inherited from a parent class or defined in an interface is different.
/** * Class of FilterFieldTypesController. */
Since that documentation comment is changed, also the class description must be changed, as the description must not repeat the class name.
- Status changed to Needs review
about 1 year ago 11:26am 26 October 2023 - ๐ฎ๐ณIndia Harsh
I have updated the patch as per comment #3.Please review
- Status changed to Needs work
about 1 year ago 1:32pm 26 October 2023 - ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
+ /** + * {@inheritdoc} + */ + public function __construct(FormBuilderInterface $formBuilder) {
That is not the documentation comment for constructors. Also, the documentation comment for constructors is not mandatory anymore.
+ * @return \Drupal\Core\Form\FormInterface + * Returns form object.
The return value description must not start with Returns.
Since that comment is changed, also the method description must be changed, as it must not start with The function returns./** - * Class of FilterFieldTypesController. + * Manages the filtering of field types in Drupal. */
in Drupal is not necessary.
- gaurav gupta Jaipur, Rajasthsan
Gaurav Gupta โ made their first commit to this issueโs fork.
- ๐ฎ๐ณIndia rakesh.regar Rajasthan, India
rakesh.regar โ made their first commit to this issueโs fork.
- Merge request !5Resolve #3395184 "Fix the issues reported by phpcs" โ (Open) created by rakesh.regar
- Status changed to Needs review
about 1 year ago 5:57am 1 November 2023 - ๐ฎ๐ณIndia rakesh.regar Rajasthan, India
MR raised updating status to needs review.
- Status changed to Needs work
about 1 year ago 1:40pm 1 November 2023 - Status changed to Needs review
about 1 year ago 11:24am 3 November 2023 - Status changed to Needs work
about 1 year ago 11:51am 3 November 2023 - Status changed to Needs review
about 1 year ago 9:15am 6 November 2023 - Status changed to Needs work
about 1 year ago 12:13pm 6 November 2023 - ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
A summary must describe what needs to be changed, and eventually why. A screenshot is not sufficient, even in the case a patch/MR is provided.
In the case of bug reports, the steps to reproduce the bug should be provided too. In the case of coding standards issues found using an automatic tool, the report given by that tool must be quoted too, including the arguments passed to that tool, if it is a command line tool.Also, since the MR is changing more files than the ones reported in the issue summary, I take the issue summary must be updated.
- ๐ฎ๐ณIndia rakesh.regar Rajasthan, India
Hey @apaderno
I have made some changes in PR and had some confution about the comment, please check it.
Thanks. - ๐ฎ๐นItaly apaderno Brescia, ๐ฎ๐น
The issue summary update does not say which command has been used to obtain the quoted report nor which CLI arguments have been passed to the command.
- First commit to issue fork.
- Status changed to Needs review
7 months ago 11:42am 22 April 2024 - ๐ฎ๐ณIndia manish-31
I have updated the MR with the changes required as per the MR feedback. Needs review.
I confirmed that there are no errors when running PHP CodeSniffer now, so I'm updating the issue status to 'Needs Review'.
- Status changed to RTBC
6 months ago 11:57am 6 June 2024 - ๐ฎ๐ณIndia deepak5423
After applying !MR5 no phpcs error was found.
Looks good to me.