Contrib.social

Document return values of Views render pipeline correctly

Open on Drupal.org →
Created on 2 February 2016, over 8 years ago
Updated 17 February 2023, over 1 year ago

Problem/Motivation

The following methods/properties are part of the Views rendering pipeline, and have missing or incorrect type information (@return/@var)

\Drupal\views\Plugin\views\display\DisplayPluginInterface::execute
\Drupal\views\Plugin\views\display\DisplayPluginInterface::preview
\Drupal\views\ViewExecutable::executeDisplay
\Drupal\views\ViewExecutable::preview
\Drupal\views\Plugin\views\display\DisplayPluginBase::$output

Proposed resolution

Document them properly

Remaining tasks

Reroll, add comments.

User interface changes

N/A

API changes

In some cases we had @return string where it hasn't returned a string in years. Is fixing the docs to reflect reality a problem there?

Data model changes

N/A

🐛 Bug report
Status

Fixed

Version

10.1 ✨

Component
Views  →

Last updated about 8 hours ago

Created by

🇺🇸United States tim.plunkett Philadelphia

Live updates comments and jobs are added and updated live.
  • VDC

    Related to the Views in Drupal Core initiative.

  • Documentation

    Primarily changes documentation, not code. For Drupal core issues, select the Documentation component instead of using this tag. In general, component selection is preferred over tag selection.

  • Coding standards

    It involves compliance with, or the content of coding standards. Requires broad community agreement.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024