Problem/Motivation
"Single Directory Components" describes something called "Directory Components" and says that they're singular.
"Single-Directory Components" describes something called "Components" and says that they're a single directory.
Counter-example to further illustrate this grammar
"Inline Form Errors" refers to form errors that are inline.
"Inline-Form Errors" would refer to errors with inline forms.
Proposed resolution
Patch module name etc. to match MAINTAINERS.txt and other docs already fixed in public.
Remaining tasks
Actual core strings and comments are probably the last things that need fixing:
- MAINTAINERS.txt has already been updated.
- The core component name has already been updated.
- Handbook docs have already been updated to the extent that we've located them.
- Nothing related to the contrib module has been changed, because it is not owned by core's final product.
User interface changes
A couple (minor) UI string changes
API changes
None, because "single-directory" and "single directory" transliterate to code names the same way.
Data model changes
Doubtful.
Release notes snippet
Not needed; just string changes probably.
Issue fork drupal-3455513
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:
- 3455513-SDC-name-11.x
changes, plain diff MR !8448
Comments
Comment #2
xjmComment #4
xjmComment #5
xjmComment #6
e0ipsoThis is good for me. I didn't know about this grammatical rule, and it didn't come up earlier in any of the reviews.
My only question is about documentation. The status quo is that code and documentation are consistent bur wrong. Changing this in code is nice and easy, but now we have inconsistent documentation (official Drupal.org docs, video keynotes, DrupalCon presentations, DrupalCamp presentations, contrib project pages, slack messages, etc.)
I am OK with the change, and I will try to use the new for moving forward, if we agree on inconsistent docs. For the record, I think this is a minor issue, so I side with the inconsistency.
Comment #7
e0ipsoTentatively setting to RTBC.
Comment #8
xjmThanks @e0ipso. I had already tried to fix the handbook docs when I became aware they did not match MAINTAINERS.txt. It would more be things like videos and sessions from past content that would be slightly disrupted, and I think people can probably figure out that "Single Directory Components" in a slide deck refers to a thing that is officially called "Single-Directory Components".
The closest example I can think of where module names needed typographic modification was when they were incorrectly named (e.g.) "Content translation module" instead of "Content Translation module". I can't think of any equivalents where this specific issue of hyphenation came up for the naming of subsystems, but we have had to make a similar fix before in lots of other Drupal UI text strings, possibly field or element labels, etc.
Comment #9
e0ipsoAgreed. This is exactly what I meant when I said I think this is a minor issue, so I side with the inconsistency., but more eloquently put.
Comment #10
xjmAdded a clearer inverse example to the issue summary that is hopefully helpful for understanding this.
Comment #12
nod_Reviewed by a subsystem maintainer
Committed and pushed 1a487f3b7c to 11.x and 4074145ef7 to 11.0.x and 5601dc41ea to 10.4.x and acbd64f9b0 to 10.3.x. Thanks!