Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Template Descriptions: Tidy up all abbreviations of 'example' to be e.g. #52848

Merged

Conversation

jordesign
Copy link
Contributor

What?

Making all abbreviations of 'For Example' to be consistent in the template descriptions

Why?

Previously the descriptions were inconsistent (and some were incorrect).

How?

Copy changes to consistently use e.g.

Testing Instructions

Can be tested by opening the Site Editor > Templates and clicking on each template to see the template details.

@jordesign
Copy link
Contributor Author

Addresses #52755

@@ -49,7 +49,7 @@ function gutenberg_get_default_block_template_types( $default_template_types ) {
$default_template_types['singular'] = array(
'title' => _x( 'Single Entries', 'Template name', 'gutenberg' ),
'description' => __(
'Displays any single entry, such as a post or a page. This template will serve as a fallback when a more specific template (e.g., Single Post, Page, or Attachment) cannot be found.',
'Displays any single entry, such as a post or a page. This template will serve as a fallback when a more specific template (e.g. Single Post, Page, or Attachment) cannot be found.',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'll also have to change the corresponding strings in the E2E tests.

See the failing test below.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ramonjd - is that something I can do within this repo - or is it tooling that is specific elsewhere?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is that something I can do within this repo

Yes for sure. The files exist in the Gutenberg repo.

If you can do a "find in files" search for the modified strings you should be able to hunt them down.

Here's the one:

'Displays any single entry, such as a post or a page. This template will serve as a fallback when a more specific template (e.g., Single Post, Page, or Attachment) cannot be found.',

I think that's the only one, but it wouldn't hurt to check

@ramonjd
Copy link
Member

ramonjd commented Jul 24, 2023

Changes LGTM. I think we just need to update the strings in the E2E tests as well 👍🏻

@jordesign
Copy link
Contributor Author

@ramonjd looks like OPTIONAL - Confirm if PHP changes require backporting to WordPress Core / Detect PHP changes (pull_request) is the only one failing now...

I'm presuming that is ok because it is optional, and not relevant to this PR?

Copy link
Member

@ramonjd ramonjd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ramonjd
Copy link
Member

ramonjd commented Jul 24, 2023

I'm presuming that is ok because it is optional, and not relevant to this PR?

You presume correct!

The issue is that that particular Github action doesn't have permissions to run on PR from forks.

I need to fix that 😄

@jordesign jordesign merged commit fbe27a5 into WordPress:trunk Jul 24, 2023
47 of 48 checks passed
@github-actions github-actions bot added this to the Gutenberg 16.4 milestone Jul 24, 2023
@jordesign jordesign deleted the template_description_eg_improvements branch July 24, 2023 02:34
@mikachan mikachan added [Type] Copy Issues or PRs that need copy editing assistance [Feature] Site Editor Related to the overarching Site Editor (formerly "full site editing") [Type] Enhancement A suggestion for improvement. labels Aug 1, 2023
@github-actions
Copy link

github-actions bot commented Aug 2, 2023

⚠️ Type of PR label error

To merge this PR, it requires exactly 1 label indicating the type of PR. Other labels are optional and not being checked here.

  • Type-related labels to choose from: [Type] Accessibility (a11y), [Type] Automated Testing, [Type] Breaking Change, [Type] Bug, [Type] Build Tooling, [Type] Code Quality, [Type] Copy, [Type] Developer Documentation, [Type] Enhancement, [Type] Experimental, [Type] Feature, [Type] New API, [Type] Task, [Type] Performance, [Type] Project Management, [Type] Regression, [Type] Security, [Type] WP Core Ticket, Backport from WordPress Core.
  • Labels found: [Type] Enhancement, [Type] Copy, [Feature] Site Editor.

You can learn more about the Type labels in Gutenberg here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Site Editor Related to the overarching Site Editor (formerly "full site editing") [Type] Copy Issues or PRs that need copy editing assistance [Type] Enhancement A suggestion for improvement.
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Template Browser: Inconsistent use of 'eg.' in Template Descriptions
3 participants