Problem/Motivation
Quoted from parent issue:
Discovered at #2972224: Add .cspell.json to automate spellchecking in Drupal core, and pointed by @xjm in https://www.drupal.org/project/drupal/issues/3122088#comment-13628724
@xjm:
Should be hyphenated (un-assign, de-prioritize, re-render, etc.)
There's an interesting question of where to draw the line for these. Generally in English these prefixes are morphologically productive with a hyphen, and get de-hyphenated when the word is adopted into common usage. "Denormalize", "Unsanitized", "Uninstantiated" etc. are all obviously in common usage in programming. "Unsticky", "Unrevisionable", and the like are Drupal terminology, and I'm surprised that "unpublish" and friends aren't already in the main dictionary.
The parent issue tried to fix all words that should be hyphenated, but the patch for this was getting too big thus making it tricky to review. Also there were some debate about which words should be hyphenated, and which shouldn't. So they argued it would be better to separate the issue into 3 smaller ones (one each for words starting with 're', 'de' and 'un'). (see comment links bellow)
#3138768 #26.2 @xjm talks about the presave word and suggests to divide the issue.
#3138768 #31 @longwave agrees to divide the issue and says it's getting tricky to review.
#3138768 #36 @davidhernandez questions about if some words should be hyphenated.
#3138768 #38 @quietone agrees with @longwave about creating separated issues.
Proposed resolution
Check and decide as a group, with first-language speakers contributing, which of the following words are correct in Drupal and which should be hyphenated, then fix them as needed on the code.
- rebuilder
- reindexing
- resave
- resaved
- resaving
- restripe
- restriped
- rethrown
- reuploading
Remaining tasks
- Decide as a group what to do with each word.
- Remove and fix the words as defined by the group.
- Review.
- Commit.
User interface changes
API changes
Data model changes
Release notes snippet
| Comment | File | Size | Author |
|---|---|---|---|
| #5 | fix-hypen-re-3265330-4.patch | 53.49 KB | arunkumark |
Issue fork drupal-3265330
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:
Comments
Comment #2
rootworkAdding Novice tag for first step.
Requires native English speaker.
Task: Look at the list of words above, and provide feedback about which should be hyphenated.
Comment #5
arunkumarkComment #6
rootworkSame comment as #3265329-7: Fix missing hyphens for prefixes - Words starting with "de". Task is to discuss which words should be hyphenated, and once there's group agreement, then create a patch.
Comment #7
sharayurajput commentedso now can I work on this @rootwork ?
Comment #8
rootwork@sharayurajput yes! You can definitely work on it. But to underscore again that the work for now is to make the case for which of these words should be hyphenated -- not to write a patch (yet).
Comment #9
cindytwilliams commentedTagging this issue for first time contributors at DrupalCon Prague 2022.
Comment #10
Peter Voumard commentedPLEASE NOTE:
I'm new here and not familiar with Drupal. I am a Tech Writer/Editor 20+ yrs and offered to make some general comments here after contacting Amber Hatz.
Primary thought building on earlier observations from xjm was to suggest terms used in the common vernacular omit a hyphen and Drupal specific terms retain a hpyhen as one way of differentiating them. Alternatively most terms unless ambiguity applies do not strictly require a hyphen per se and as such all terms COULD omit the hyphen with Drupal specific terms being denoted in some way in the global glossary.
These are just suggestions the Drupal Core team may wish to use when deciding how to approach the issue of un, de, and re terms for Drupal Help.
Following HERE I will apply my general knowledge of what may/may not be a Drupal term so please factor that in as I am certainly no expert. just wishing to help where I can.
Whilst I have seen refs for reparse used in Drupal it is also a common term. On that assumption I suggest removal of hyphen as no ambiguity applies either.
SUGGESTION: Reparsed
Whilst I have seen refs for resave used in Drupal it is also a common term. On that assumption I suggest removal of hyphen as no ambiguity applies.
SUGGESTION: Resave
Whilst I have seen refs for refactoring used in Drupal it is also a common term. On that assumption I suggest removal of hyphen as no ambiguity applies.
SUGGESTION: Refactorings
Whilst I have seen refs for refactoring used in Drupal it is also a common term. On that assumption I suggest removal of hyphen as no ambiguity applies.
SUGGESTION: Refactorings
COMMENT ON REMAINING ITEMS IN PATCH
SUGGESTION: ALL remaining terms do not appear to be obviously Drupal specific so suggesting NO hyphen applies.
NOTE: I’m not a developer but as a Tech Writer have a familiarity with the majority of these IT terms BUT this requires someone familiar with Drupal code/useage IF any of these items DO have a special meaning in Drupal??
Reinject
Resave (d) (ing)
Rethrown
Rebuilder
Reclosed
Recolorable
Redeclaration
Redirections
Reimplement
Reindex (ing)
Renormalize
Reparenting
Reparsed
Rethrown
Re-Indexing *Note this term is used in at least once instance when referring to the “Re-index site” button. Technically I could leave as is but for a wholesale approach would rename the button to Reindex site. Another reference relates to Search Re-index Confirmation Form, again could rename to Reindex here. Yet another reference refers to the Re-index button on the Admin page, rename to Reindex.
Reclosed
Resampling
Rehyrdated *used in a non IT context for Asian cooking. Should this be included in a Glossary?? I can see this appears to be part of a Demo module for Drupal.
Hope this Helps.
No point in me reviewing un or de terms as we probably need to decide upon a universal approach for Drupal and non Drupal terms w.rt. hyphens.
Comment #13
quietone commentedComment #14
quietone commentedUpdate word list
Comment #17
chandansha commentedCreated patch to MR and fixed remaining words
Comment #18
smustgrave commentedMR appears to have issues