Problem/Motivation

The class comment for Drupal\Core\Menu::MenuLinkTreeElement() includes these lines:

/**
 * Provides a value object to model an element in a menu link tree.
 *
 * \Drupal\Core\Menu\MenuLinkTreeElement objects represent a menu link's data.
 * Objects of this class provide complimentary data: the placement in a tree.
...
*/

The class that "represent a menu link's data" should be something other than "this class".

Also, the doc block uses "complimentary" when it means "complementary": in the quoted snippet and again a few lines later.

Proposed resolution

  1. Replace MenuLinkTreeElement with MenuLinkInterface
  2. Replace "complimentary" with "complementary" (twice).

Remaining tasks

User interface changes

None

API changes

None

Data model changes

None

Release notes snippet

N/A

Issue fork drupal-3323855

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

benjifisher created an issue. See original summary.

benjifisher’s picture

Status: Active » Needs review
smustgrave’s picture

Status: Needs review » Reviewed & tested by the community
Issue tags: +Bug Smash Initiative

tagging for bugsmash. Changes look simple to me so RTBC

benjifisher’s picture

Assigned: benjifisher » Unassigned

  • catch committed 352c603 on 10.0.x
    Issue #3323855 by benjifisher: Improve class comment for Drupal\Core\...
  • catch committed c731970 on 10.1.x
    Issue #3323855 by benjifisher: Improve class comment for Drupal\Core\...
catch’s picture

Version: 10.1.x-dev » 10.0.x-dev
Status: Reviewed & tested by the community » Fixed

Committed/pushed to 10.1.x and cherry-picked to 10.0.x, thanks!

Status: Fixed » Closed (fixed)

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