Problem/Motivation

Several argument default plugins lack inheritdoc docblocks.

They are in:
- Drupal\taxonomy\Plugin\views\argument_default\Tid
- Drupal\user\Plugin\views\argument_default\CurrentUser
- Drupal\views\Plugin\views\argument_default\Fixed
- Drupal\views\Plugin\views\argument_default\Raw

Proposed resolution

Fix the docs.

Remaining tasks

Fix the docs.

User interface changes

None.

API changes

None.

Data model changes

None.

CommentFileSizeAuthor
#9 interdiff-2600328-7-9.txt1.13 KBaanschut
#9 inheritdoc-2600328-9.patch3.92 KBaanschut
#7 interdiff-2600328-5-7.txt1.09 KBbrandenlhamilton
#7 inheritdoc-2600328-7.patch2.79 KBbrandenlhamilton
#5 interdiff-2600328-4-5.txt565 bytesaanschut
#5 inheritdoc-2600328-5.patch1.71 KBaanschut
#4 inheritdoc-2600328-4.patch1.15 KBbrandenlhamilton
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Anonymous’s picture

Anonymous (not verified) CreditAttribution: Anonymous at XIO commented

pjonckiere created an issue. See original summary.

aanschut’s picture

aanschut CreditAttribution: aanschut as a volunteer commented
Issue tags: +rc eligible

This is RC eligible according to https://www.drupal.org/core/d8-allowed-changes#rc where this is a doc change.
I and brandenlhamilton are working on this.

brandenlhamilton’s picture

brandenlhamilton CreditAttribution: brandenlhamilton commented

Hey @aanschut,

Checkout https://www.drupal.org/coding-standards/docs#inheritdoc for the Drupal Coding Standards for {@inheritdoc}s

brandenlhamilton’s picture

brandenlhamilton CreditAttribution: brandenlhamilton commented
FileSize
inheritdoc-2600328-4.patch1.15 KB

Working with @aanschut, produced this beginning patch that updates Drupal\taxonomy\Plugin\views\argument_default\Tid

aanschut’s picture

aanschut CreditAttribution: aanschut as a volunteer commented
FileSize
inheritdoc-2600328-5.patch1.71 KB
interdiff-2600328-4-5.txt565 bytes

Patch adds inheritdoc blocks in Drupal\user\Plugin\views\argument_default\CurrentUser. Interdiff included

aanschut’s picture

aanschut CreditAttribution: aanschut as a volunteer commented
brandenlhamilton’s picture

brandenlhamilton CreditAttribution: brandenlhamilton commented
FileSize
inheritdoc-2600328-7.patch2.79 KB
interdiff-2600328-5-7.txt1.09 KB

Updates patch to now include Drupal\views\Plugin\views\argument_default\Fixed. Interdiff included.

dawehner’s picture

dawehner
Primary language German
CreditAttribution: dawehner as a volunteer and at Chapter Three commented
Status: Active » Needs work

Thank you for the patch!

\Drupal\views\Plugin\views\argument_default\Fixed ... this could have a couple of those more.

...

aanschut’s picture

aanschut CreditAttribution: aanschut as a volunteer commented
FileSize
inheritdoc-2600328-9.patch3.92 KB
interdiff-2600328-7-9.txt1.13 KB

Patch adds inheritdoc blocks in Drupal\views\Plugin\views\argument_default\Raw. Interdiff included.

dawehner’s picture

dawehner
Primary language German
CreditAttribution: dawehner as a volunteer and at Chapter Three commented
Status: Needs work » Reviewed & tested by the community

The patch is perfect now

mradcliffe’s picture

mradcliffe
he/him
Primary language English
CreditAttribution: mradcliffe at Kosada commented

Patch looks great. Thanks!

mradcliffe’s picture

mradcliffe
he/him
Primary language English
CreditAttribution: mradcliffe at Kosada commented
Title: Argument default plugin docblocs » Argument default plugin docblocks

Fixing issue title.

xjm’s picture

xjm
she/her
Primary language English
CreditAttribution: xjm at Acquia commented
Status: Reviewed & tested by the community » Fixed

Thanks for the patch! I confirmed that all these are indeed overridden methods. Committed and pushed to 8.0.x.

  • xjm committed a092001 on 8.0.x 
    Issue #2600328 by aanschut, brandenlhamilton, dawehner, pjonckiere:...

Status: Fixed » Closed (fixed)

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