Filing this to fix later when it doesn't clash with where I'm working right now.

Should be a quick job with a regex search & replace.

CommentFileSizeAuthor
#15 docblocks_should_use-2565283-15.patch2.58 KBpravin ajaaz
#12 flag-docblock-inheritdoc-2565283-11.patch2.5 KBrashid_786
#7 flag-docblock-inheritdoc-2565283-5.patch2.51 KBrashid_786
#3 docblocks_should_use-2565283-3.patch2.43 KBpravin ajaaz

Comments

joachim created an issue. See original summary.

socketwench’s picture

socketwench commented
Issue tags: +Novice

Seems perfect for a novice!

pravin ajaaz’s picture

pravin ajaaz commented
Status: Active » Needs review
StatusFileSize
new docblocks_should_use-2565283-3.patch2.43 KB

Altered doc blocks as @inheritdoc.

Status: Needs review » Needs work

The last submitted patch, 3: docblocks_should_use-2565283-3.patch, failed testing.

Status: Needs work » Needs review

Pravin Ajaaz queued 3: docblocks_should_use-2565283-3.patch for re-testing.

Status: Needs review » Needs work

The last submitted patch, 3: docblocks_should_use-2565283-3.patch, failed testing.

rashid_786’s picture

rashid_786 commented
Status: Needs work » Needs review
StatusFileSize
new flag-docblock-inheritdoc-2565283-5.patch2.51 KB

Status: Needs review » Needs work

The last submitted patch, 7: flag-docblock-inheritdoc-2565283-5.patch, failed testing.

joachim’s picture

joachim commented

Thanks for the patch!

+++ b/src/Controller/FlagListBuilder.php
@@ -77,9 +77,7 @@ class FlagListBuilder extends ConfigEntityListBuilder {
-   * Overrides Drupal\Core\Entity\EntityListController::render().
-   *
-   * We override the render() method to add helpful text below the entity list.
+   * {@inheritdoc}   ¶
    */

There's surplus whitespace here I'm afraid.

Also, we're losing the comment. I don't remember what the standard is for adding extra docs below an @inheritdoc -- I know there is a core issue about this.

pravin ajaaz’s picture

pravin ajaaz commented

I think you are referring to https://www.drupal.org/node/1994890

rashid_786’s picture

rashid_786 commented

Whitespace has been removed. As per the current recommendations {@inheritdoc} should be used for overridden methods https://www.drupal.org/coding-standards/docs#inheritdoc.

rashid_786’s picture

rashid_786 commented
Status: Needs work » Needs review
StatusFileSize
new flag-docblock-inheritdoc-2565283-11.patch2.5 KB

Status: Needs review » Needs work

The last submitted patch, 12: flag-docblock-inheritdoc-2565283-11.patch, failed testing.

joachim’s picture

joachim commented

> Also, we're losing the comment. I don't remember what the standard is for adding extra docs below an @inheritdoc -- I know there is a core issue about this.

Thanks for finding the issue for @inheritdoc! It looks like the docs maintainer is not keen on extra docs there at all. So could the comment be moved to an inline comment at the top of the function please?

(BTW, ignore tests failing -- it's due to another issue. This is a docs-only patch, so I will commit regardless of tests.)

pravin ajaaz’s picture

pravin ajaaz commented
Status: Needs work » Needs review
StatusFileSize
new docblocks_should_use-2565283-15.patch2.58 KB

Patch as per your suggestion.

Status: Needs review » Needs work

The last submitted patch, 15: docblocks_should_use-2565283-15.patch, failed testing.

  • joachim committed d414163 on 8.x-4.x authored by Pravin Ajaaz 
    Issue #2565283 by Pravin Ajaaz, rashid_786: Fixed docblocks for...
joachim’s picture

joachim commented
Status: Needs work » Fixed

Thanks!

Committed. Tests are failing due to a change in core, and this is a docs-only patch, so it's fine.

Status: Fixed » Closed (fixed)

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