Problem/Motivation

The docblock for Drupal.viewsUi.FormFieldFiller is not in adherance with comment standards in regards to @param (optional).
https://www.drupal.org/coding-standards/docs#param

Proposed resolution

Patch below.

Remaining tasks

None.

User interface changes

None.

API changes

None.

CommentFileSizeAuthor
#1 drupal-views-docs-2302511-1.patch1.04 KBElijah Lynn
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Elijah Lynn’s picture

Elijah Lynn
Location Portland, Oregon
CreditAttribution: Elijah Lynn commented
Issue summary: View changes
Status: Active » Needs review
FileSize
drupal-views-docs-2302511-1.patch1.04 KB
Elijah Lynn’s picture

Elijah Lynn
Location Portland, Oregon
CreditAttribution: Elijah Lynn commented
Issue summary: View changes

Added link to https://www.drupal.org/coding-standards/docs#param

Elijah Lynn’s picture

Elijah Lynn
Location Portland, Oregon
CreditAttribution: Elijah Lynn commented
Component: views_ui.module » documentation
MKorostoff’s picture

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

Confirming that this patch applies cleanly as of b96e823, and that it has the impact described above.

In reviewing this patch I 1) read the patch to confirm that it has the desired impact and 2) applied the patch and then viewed core/modules/views_ui/js/views-admin.js to confirm that it does indeed now adhere to https://www.drupal.org/coding-standards/docs#param

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott commented
Status: Reviewed & tested by the community » Fixed

Committed 40723e1 and pushed to 8.x. Thanks!

  • alexpott committed 40723e1 on 8.x 
    Issue #2302511 by Elijah Lynn:  (optional) improvements in docblock for...

Status: Fixed » Closed (fixed)

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