Contrib.social

Add the missing documentation comments to core/lib/Drupal/Component/Diff.php

Open on Drupal.org →
Created on 10 February 2023, almost 2 years ago
Updated 5 July 2023, over 1 year ago

Problem/Motivation

1. In 'core/lib/Drupal/Component/Diff' I can see many functions has no doc comments.
It, as the comments said that lift from Perl diff, but it is better to add the docs.

2. This component also having comment out code:
core/lib/Drupal/Component/Diff/Diff.php: Line 39

  public function __construct($from_lines, $to_lines) {
    ...
    //$this->_check($from_lines, $to_lines);
  }

Proposed resolution

Add function doc comments.
Remove the comment out code.

📌 Task
Status

Closed: won't fix

Version

10.0 ✨

Component
Documentation  →

Last updated 2 days ago

No maintainer
Created by

🇻🇳Vietnam tra.duong

Live updates comments and jobs are added and updated live.
  • 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.

  • Issue created by @tra.duong
  • Comment almost 2 years ago →
    🇮🇳India TanujJain-TJ

    adding a patch for this issue. Added missing doc comments and fixed phpcs issues.

  • Status changed to Needs review almost 2 years ago
  • Comment almost 2 years ago →
    🇮🇳India TanujJain-TJ
  • Comment almost 2 years ago →
    🇮🇳India TanujJain-TJ

    Removed commented code from core/lib/Drupal/Component/Diff/Diff.php: Line 39 in patch - #4 also attaching interdiff file. Please review.

  • Status changed to Closed: won't fix over 1 year ago
  • Comment over 1 year ago →
    🇳🇿New Zealand quietone

    Thanks for the interest in Drupal coding standards. The files being changed here is third party code that we copy/paste. We do not convert it to our coding standards and it is deliberately ignored by our automated coding standards compliance checks. That makes this issue a won't fix.

    If you want to work on coding standards, Join #coding-standards in Drupal Slack → . The people there can help you find a suitable issue to work on. There is also 🌱 [meta] Fix PHP coding standards in core Active where you can find issue that are currently being worked on.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024