Improve comments in \Drupal\Core\Entity\Query\Sql\Tables

Created on 26 October 2015, about 9 years ago
Updated 3 September 2024, 4 months ago

Problem/Motivation

Some comment in \Drupal\Core\Entity\Query\Sql\Tables are hard to read.

Original issue summary

Issue referred from https://www.drupal.org/node/2599524#comment-10490444

    +++ b/core/lib/Drupal/Core/Entity/Query/Sql/Tables.php
    @@ -235,7 +235,9 @@ public function isFieldCaseSensitive($field_name) {
    
    @@ -235,7 +235,9 @@ public function isFieldCaseSensitive($field_name) {
        * Join entity table if necessary and return the alias for it.
        *
        * @param string $property
    +   *
        * @return string
    +   *
        * @throws \Drupal\Core\Entity\Query\QueryException
        */

    Sigh. This @param and @return need to have docs added to them. Having @param and @return with only a type and no documentation is not OK.

Steps to reproduce

Proposed resolution

Adjust the grammar.

Remaining tasks

Review
Commit

User interface changes

API changes

Data model changes

Release notes snippet

🐛 Bug report
Status

Fixed

Version

11.0 🔥

Component
Documentation 

Last updated 1 day ago

No maintainer
Created by

🇮🇳India krknth

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

    It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

Sign in to follow issues

Merge Requests

Comments & Activities

Not all content is available!

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

Production build 0.71.5 2024