Fix spelling of 5 'un' words in comments

Created on 9 October 2023, 9 months ago
Updated 17 June 2024, 11 days ago

Problem/Motivation

This is a child issue of 🌱 [meta] Fix missing hyphens for prefixes - Words starting with "un" Active that aims to address the incorrect usage of several words beginning with the prefix "un" in Drupal\Tests\path_alias\Unit\AliasManagerTest and other files. Specifically, this relates to the words "unpreloaded", "uninstallations", "unstripped", and "untranslatable"

  /**
   * Tests the getAliasByPath cache with an unpreloaded path with alias.
   *
   * @covers ::getAliasByPath
   * @covers ::writeCache
   */
  /**
   * Tests the getAliasByPath cache with an unpreloaded path without alias.
   *
   * @covers ::getAliasByPath
   * @covers ::writeCache
   */

Proposed resolution

Rework comments to remove the following words. There is a small set of words here but the remaining words with the 'un' prefix are used in code or in user facing text. git stat

  1. undoable
  2. unfieldable
  3. ninstallation
  4. uninstallations
  5. unpublishes

Remaining tasks

Review
Commit

User interface changes

API changes

Data model changes

Release notes snippet

πŸ› Bug report
Status

Needs work

Version

11.0 πŸ”₯

Component
OtherΒ  β†’

Last updated 32 minutes ago

Created by

πŸ‡§πŸ‡·Brazil ashley_herodev

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @ashley_herodev
  • First commit to issue fork.
  • last update 9 months ago
    30,384 pass
  • Status changed to Needs review 9 months ago
  • πŸ‡§πŸ‡·Brazil elber Brazil

    hi please revise

  • Pipeline finished with Success
    9 months ago
    #28515
  • Status changed to RTBC 9 months ago
  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    Tagging as novice, for new user

    Read the change a few times and think it reads fine. "an alias" may also work but think this works.

  • Status changed to Needs work 9 months ago
  • πŸ‡³πŸ‡ΏNew Zealand quietone New Zealand

    @ashley_herodev, thank you for working on a spelling issue!

    I read the IS and see two instances of the word to change. I then read the MR and see only one change. This will need more work.

    So when working on spelling issues there is some more steps to do as well. The misspelled word is in the core dictionary and we want to remove that. What we do is delete the misspelled word from the dictionary and then run the spell checker, yarn spellcheck:core to find all the instances of that word. Then fix each one until yarn spellcheck:core runs without error. There is more information and links to helpful pages to be found in the Meta issue for spelling, πŸ“Œ [Meta] Remove spelling errors from dictionary.txt and fix them Active .

    It is also not practical to make an issue for each word. To make good use of reviewers and committers time the scope of this should expand to include other words prefixed with 'un' but not too many such that the change is too large. And the changes should be similar. For example this one is only found in a comment, so finding others that are also only changed in a comment would be a good way to scope this. There is information about patch size β†’ that suggests a limit of 100 lines.

    I am restoring the standard template so that the remaining tasks is available. Adding the tag for spelling errors. Also, tagging for a title update. I don't see a duplicated name.

  • πŸ‡³πŸ‡ΏNew Zealand quietone New Zealand

    I did some searching and these are likely candidate words that can be included in this change. These are words that should only be changed in comments. I am not suggesting that all these be done in this MR. The overall size of the change must be considered and the load on the reviewer who has to read each change in context.

    unallowed
    unassigning
    unclickable
    uncollapsible
    ungenerated
    uninstallations
    unmanaged
    unpermissioned
    unrouted
    unstripped
    untabbable
    untarring
    untrustable
    unvalidated
    unwrapper

  • First commit to issue fork.
  • Pipeline finished with Failed
    4 months ago
    Total: 192s
    #95205
  • Pipeline finished with Canceled
    4 months ago
    Total: 185s
    #95209
  • Pipeline finished with Success
    4 months ago
    Total: 499s
    #95212
  • Status changed to Needs review 4 months ago
  • πŸ‡²πŸ‡½Mexico GafgarionMorua Puerto Vallarta

    Updated comments for clarity and grammar conformance. Replaced ambiguous language and terms with more explicit phrases.

  • Pipeline finished with Success
    4 months ago
    Total: 601s
    #95218
  • Status changed to Needs work 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    #7 @quietone mentioned updating the title

    #8 @quietone also mentioned some words that could be target. Which were chosen? They should be included in the issue summary.

  • πŸ‡²πŸ‡½Mexico GafgarionMorua Puerto Vallarta
  • Pipeline finished with Canceled
    4 months ago
    Total: 317s
    #95954
  • Pipeline finished with Success
    4 months ago
    Total: 472s
    #95958
  • πŸ‡²πŸ‡½Mexico GafgarionMorua Puerto Vallarta
  • πŸ‡²πŸ‡½Mexico GafgarionMorua Puerto Vallarta
  • Status changed to Needs review 4 months ago
  • πŸ‡²πŸ‡½Mexico GafgarionMorua Puerto Vallarta

    I updated the summary to represent the changes better. Whenever you have a minute, please review the MR. I appreciate your time.

  • Status changed to Needs work 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    So reading remaining tasks

    Update the misused words from the comments, particularly "unpreloaded", "uninstallations", "unstripped", and "untranslatable".

    Has that been done?

  • Status changed to Needs review 13 days ago
  • πŸ‡³πŸ‡ΏNew Zealand quietone New Zealand

    Updated the issue summary as quite a few words with the 'un' prefix have been fixed elsewhere. And updated the MR to get this back on track.

  • Status changed to RTBC 11 days ago
  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    5 words much easier to review.

    Re-read the replacements read fine to me.

  • Status changed to Needs work 11 days ago
  • πŸ‡ΊπŸ‡ΈUnited States xjm

    Okay, this issue went in a direction that was not what I intended originally. It is actually making grammatically incorrect changes (e.g., treating "install" and "uninstall" as nouns, which they are not).

    The reasoning behind this set of issues was that some "un-" words should be hyphenated, and others that were legitimately a part of Drupal terminology should be moved to the correct issues.

    We should not be rewording sentences to try to remove the word "uninstallation" from the codebase. It is a completely legitimate word. Instead, that word should be moved to the Drupal dictionary. This is similarly true for "untranslatable", which is a Drupal concept used in property names and the like. "Unpublished" also falls in that category. I would make the case that "Unfieldable" does as well.

    So, this issue is mixing up "undoable" -- which does indeed deserve hyphenating and rewording.

    Let's get this rescoped -- add "unpublish", "uninstall", and their derivatives, as well as "unfieldable", to the Drupal dictionary in one issue. Fix the other two in another (can be this issue).

    Thanks!

Production build 0.69.0 2024