Problem/Motivation

The sniff 'Drupal.Commenting.DocComment.MissingShort' is not enabled.

Steps to reproduce

Proposed resolution

Fix violations in KernelTest tests.

Remaining tasks

Review.

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

CommentFileSizeAuthor
#19 3517501-nr-bot_fnvnsobr.txt91 bytesneeds-review-queue-bot
#17 3517501-nr-bot_ou9ft4r4.txt91 bytesneeds-review-queue-bot
#10 3517501-nr-bot.txt91 bytesneeds-review-queue-bot
#7 3517501-nr-bot.txt31.3 KBneeds-review-queue-bot

Issue fork drupal-3517501

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

quietone created an issue. See original summary.

quietone’s picture

quietone commented
Status: Fixed » Active

quietone opened merge request !11742

annmarysruthy’s picture

annmarysruthy commented
Assigned: Unassigned » annmarysruthy
annmarysruthy’s picture

annmarysruthy commented
Assigned: annmarysruthy » Unassigned
Status: Active » Needs review

Fixed remaining violations and phpstan issue. Kindly review

smustgrave’s picture

smustgrave commented
Status: Needs review » Reviewed & tested by the community

Reviewed the changes and seem like good updates.

needs-review-queue-bot’s picture

needs-review-queue-bot commented
Status: Reviewed & tested by the community » Needs work
StatusFileSize
new 3517501-nr-bot.txt31.3 KB

The Needs Review Queue Bot tested this issue. It fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".

This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

quietone’s picture

quietone commented
Status: Needs work » Needs review

Rebase an changes for new files.

smustgrave’s picture

smustgrave commented
Status: Needs review » Reviewed & tested by the community

Rebase seems good.

needs-review-queue-bot’s picture

needs-review-queue-bot commented
Status: Reviewed & tested by the community » Needs work
StatusFileSize
new 3517501-nr-bot.txt91 bytes

The Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".

This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

quietone’s picture

quietone commented
Status: Needs work » Needs review

Catching up to HEAD.

smustgrave’s picture

smustgrave commented
Status: Needs review » Reviewed & tested by the community

Seems to be a good rebase

catch made their first commit to this issue’s fork.

xjm’s picture

xjm
she/her
Primary language English
commented

Looks like the pipeline got stuck, which apparently happens when a committer rebases a branch, commits suggestions, etc. without having access to the fork. I tried to fix it by getting access to the fork and then re-running the pipeline.

xjm’s picture

xjm
she/her
Primary language English
commented
Status: Reviewed & tested by the community » Needs work

NW for a number of small fixes and a couple of those "reword to be under 80 characters". If needed, we can add a separate paragraph to the docblock (note: the one-line summary should not just be wrapped to two lines). Thanks!

quietone’s picture

quietone commented
Status: Needs work » Needs review

Time for another review.

needs-review-queue-bot’s picture

needs-review-queue-bot commented
Status: Needs review » Needs work
StatusFileSize
new 3517501-nr-bot_ou9ft4r4.txt91 bytes

The Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".

This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

quietone’s picture

quietone commented
Status: Needs work » Needs review
needs-review-queue-bot’s picture

needs-review-queue-bot commented
Status: Needs review » Needs work
StatusFileSize
new 3517501-nr-bot_fnvnsobr.txt91 bytes

The Needs Review Queue Bot tested this issue. It no longer applies to Drupal core. Therefore, this issue status is now "Needs work".

This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.

Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.

quietone changed the visibility of the branch 3517501-fix-doccomment.missingshort-in to hidden.

quietone changed the visibility of the branch 3517501-fix-doccomment.missingshort-in to active.

quietone’s picture

quietone commented
Status: Needs work » Needs review
dcam’s picture

dcam commented
Status: Needs review » Needs work

The changes for @xjm's feedback have been addressed with the exception of the one about the $cachedDiscoveries property. I left a suggestion for it.

quietone’s picture

quietone commented
Status: Needs work » Needs review

@dcam, thanks.

There was also another fix added as we chase HEAD, so needs review for that.

dcam’s picture

dcam commented
Status: Needs review » Reviewed & tested by the community

I reviewed the new change. It looks fine.

All feedback has been resolved. I double-checked all the changes too. They look ok to me. I'm going to mark this as RTBC.

longwave made their first commit to this issue’s fork.

  • longwave committed 42372c26 on 11.3.x 
    docs: #3517501 Fix 'DocComment.MissingShort' in KernelTest tests

By:...
longwave’s picture

longwave
he/him
Primary language English
Location UK
commented
Version: 11.x-dev » 11.3.x-dev
Status: Reviewed & tested by the community » Fixed

Committed and pushed f6f59e12573 to 11.x and 42372c268e6 to 11.3.x. Thanks!

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

  • longwave committed f6f59e12 on 11.x 
    docs: #3517501 Fix 'DocComment.MissingShort' in KernelTest tests

By:...

longwave closed merge request !11742

longwave’s picture

longwave
he/him
Primary language English
Location UK
commented
Status: Reviewed & tested by the community » Fixed

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.