Problem/Motivation

Wording is wrong in attributes documentation. 'a' should be 'an'.

/**
   * The url which is used for the image in this Tip.
   *
   * @var string
   *   A url used for the image.
   */
  protected $url;

  /**
   * The alt text which is used for the image in this Tip.
   *
   * @var string
   *   A alt text used for the image.
   */
  protected $alt;

Comments

GoZ created an issue. See original summary.

goz’s picture

Status: Active » Needs review
Issue tags: +Quick fix, +Quickfix, +Documentation
StatusFileSize
new1.2 KB
shadcn’s picture

+++ b/core/modules/tour/tests/tour_test/src/Plugin/tour/tip/TipPluginImage.php
@@ -19,7 +19,7 @@ class TipPluginImage extends TipPluginBase {
+   *   An url used for the image.

Hmm, I believe "A url" is correct here.

Here's a related issue: #2574981: Fix grammar ("an URL" should be "a URL") and consistent use of URL (not "url" / "Url") in documentation only, part 1.

goz’s picture

StatusFileSize
new985 bytes

Right arshadcn, i had missed this grammar rule for url.
Still stay the alt one

goz’s picture

Title: Wrong wording in tour_test TipPluginImage doc » Fix grammar 'a alt' in tour_test TipPluginImage doc
riddhi.addweb’s picture

Assigned: Unassigned » riddhi.addweb
shadcn’s picture

Status: Needs review » Reviewed & tested by the community

Thanks @GoZ. Looking good.

riddhi.addweb’s picture

Assigned: riddhi.addweb » Unassigned
th_tushar’s picture

Looks good. +1

cilefen’s picture

Status: Reviewed & tested by the community » Closed (duplicate)

We are not going to commit this and #2851394: Fix grammar 'a' to 'an' when necessary