Make help text consistent on entity bundle forms (Content/Comment/Media/Block)

Minor tweaks for consistency don't need explicit sign-off from usability topic maintainers.
Go for it.

That case think we are good.

@committers, if this gets committed, I'm not sure it would be fair to give me credit for such an easy fix, but up to your discretion.

Even small tweaks deserve credit as it helps make Drupal a better place!

Ugh, I forgot about 'Comment types'. Updating title and issue summary.

Added block types to the table as well.

@smustgrave, what do you think about these changes to make "all the things" consistent?

I think this title reads better

Describe this foo type.

These duplicate the label and are a bit bossy :) I think these can be left out.

Updated patch with suggestion in #20

LGTM.

The last submitted patch, 21: make-help-text-consistent-on-entity-bundle-forms-21.patch, failed testing. View results →

I'm not sure what the test failure → means:

Unknown
fail: [run-tests.sh check] Line 0 of :
FATAL Drupal\Tests\Core\Command\QuickStartTest: test runner returned a non-zero error code (2).

@Chris Matthews, thanks for making this issue. A consistent UI is helpful for the user.

The Issue Summary is up to date. I don't see any unanswered questions. I also don't see any testing of the patch. This is changing several pages and they should be checked manually. Setting to NW for that.

I applied the patch and checked a page. On this page there are two fields with descriptions that are two sentences. They are
A unique human-readable name for this content type. This name will display on the Content types page.
and
A unique machine-readable name for this content type. Can only contain lowercase letters, numbers, and underscores.

My eye really notices that the two second sentences start differently. How about changing the second one to 'This can only ...'? It also seems to me that the sentence doesn't have a subject. It is just implied.

I then searched core for 'letters, numbers' and there are similar strings in other places. Those should be looked at and a follow up made to do those. And keep this to improving the 'add content type' forms.

Updated patch with suggestion in #26

The last submitted patch, 27: 3364773-27.patch, failed testing. View results →

minor error which i was removed in this file.Please review.

please review.

Feedback appears to be addressed.

This is a great issue, better than "minor" priority. :)

Saving issue credits. Thanks everyone for working on this! A few things to fix:

1. +++ b/core/modules/block_content/src/BlockContentTypeForm.php
   @@ -35,12 +35,13 @@ public function form(array $form, FormStateInterface $form_state) {
   +      '#description' => $this->t("Unique machine-readable name: lowercase letters, numbers, underscores only."),
   

   This is missing the word "and". It should be fixed in all instances of this string in the patch).

2. +++ b/core/modules/comment/src/CommentTypeForm.php
   @@ -83,11 +83,13 @@ public function form(array $form, FormStateInterface $form_state) {
   +      '#description' => $this->t('A unique human-readable name for this comment type, displayed on the <em>Comment types</em> page.'),
   

   I don't think labels actually need to be unique -- only machine names have that constraint. So the word "unique" should be removed from all strings about the labels.

Finally, since this is a consistent form pattern across entity types, I wonder if this text should be automatically provided by a base form class by default. Tagging for a followup to look into that. For this issue, simply improving the existing strings is a sufficient improvement.

Thanks everyone!

Oh, @quietone is also correct in that it should be manually tested and have screenshots posted before being marked RTBC. Thanks!

Hello Everyone,
Added the patch for updating description addressed in #33
kindly review the changes.

Thank you.

Description Updated after adding description-update-3364773-29.patch. Manually Tested on the drupal 11.x
Added screenshots for more comprehensive view

Thank you.

Thanks @thakurnishant_06 for the fix and screenshots!

1. When you update a patch, be sure to provide an interdiff → so we can see the changes you've made.
    

With screenshots, it's also helpful to crop them to only the necessary/changed part of the user interface, and to embed them in the issue summary.

2. +++ b/core/modules/block_content/src/BlockContentTypeForm.php
   @@ -44,13 +44,14 @@ public function form(array $form, FormStateInterface $form_state) {
   +      '#description' => $this->t("Unique machine-readable name: lowercase letters, numbers and underscores only."),
   
   +++ b/core/modules/comment/src/CommentTypeForm.php
   @@ -91,6 +92,7 @@ public function form(array $form, FormStateInterface $form_state) {
   +      '#description' => $this->t('Unique machine-readable name: lowercase letters, numbers and underscores only.'),
   
   +++ b/core/modules/media/src/MediaTypeForm.php
   @@ -110,14 +110,14 @@ public function form(array $form, FormStateInterface $form_state) {
   +      '#description' => $this->t('Unique machine-readable name: lowercase letters, numbers and underscores only.'),
   
   +++ b/core/modules/node/src/NodeTypeForm.php
   @@ -83,7 +83,7 @@ public function form(array $form, FormStateInterface $form_state) {
   +      '#description' => $this->t('Unique machine-readable name: lowercase letters, numbers and underscores only.', [
   

   This is now missing the required Oxford comma after "numbers".

3. +++ b/core/modules/block_content/src/BlockContentTypeForm.php
   @@ -44,13 +44,14 @@ public function form(array $form, FormStateInterface $form_state) {
   +      '#description' => $this->t('This description will display on the <em>Block types</em> page.'),
   
   +++ b/core/modules/comment/src/CommentTypeForm.php
   @@ -98,7 +100,7 @@ public function form(array $form, FormStateInterface $form_state) {
   +      '#description' => $this->t('This description will display on the <em>Comment types</em> page.'),
   
   +++ b/core/modules/media/src/MediaTypeForm.php
   @@ -110,14 +110,14 @@ public function form(array $form, FormStateInterface $form_state) {
   +      '#description' => $this->t('This description will display on the <em>Media types</em> page.'),
   
   +++ b/core/modules/node/src/NodeTypeForm.php
   @@ -92,7 +92,7 @@ public function form(array $form, FormStateInterface $form_state) {
   +      '#description' => $this->t('This description will display on the <em>Content types</em> page.'),
   

   The label for the form element already tells them it's a description, so we don't need to repeat that. Remember: Fewer words == better UX.

   These strings can simply be:

   Displays on the _______ page.

   (Fill in the blank as appropriate for each.)
    

4. We also still need the followup issue filed.

Thanks everyone!

Hello @xjm,
Thanks for the review , I will work on the suggested changes :)

Added the patch with changes suggested in #40. Kindly review the changes.
Thank you.

xjm → closed merge request !4873

Created and closed an MR to hide the confusing issue fork repo.

Opened 📌 Look into singular location for help text Active

Looks great. Committed to 11.x. (I also accidentally committed it to 10.1.x but reverted that; it is not backportable as it includes string changes.) Thanks everyone!

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