Skip to content

Add a few code backticks#46445

Open
zackkatz wants to merge 2 commits into
WordPress:trunkfrom
zackkatz:patch-1
Open

Add a few code backticks#46445
zackkatz wants to merge 2 commits into
WordPress:trunkfrom
zackkatz:patch-1

Conversation

@zackkatz
Copy link
Copy Markdown

@zackkatz zackkatz commented Dec 9, 2022

What?

Just very minor formatting.

Why?

There was a space missing between sentences and missing code ticks.

@zackkatz zackkatz requested a review from noahtallen as a code owner December 9, 2022 21:20
@github-actions github-actions Bot added the First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository label Dec 9, 2022
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Dec 9, 2022

👋 Thanks for your first Pull Request and for helping build the future of Gutenberg and WordPress, @zackkatz! In case you missed it, we'd love to have you join us in our Slack community, where we hold regularly weekly meetings open to anyone to coordinate with each other.

If you want to learn more about WordPress development in general, check out the Core Handbook full of helpful information.

Copy link
Copy Markdown
Contributor

@alexstine alexstine left a comment

Choose a reason for hiding this comment

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

@zackkatz Thanks for the PR.

Wondering how necessary it is to mark some of this as code. I can see the example being useful, but WP ENV, NPM, and NPX are used in describing terms, not really commands in my opinion.

@alexstine alexstine added [Type] Developer Documentation Documentation for developers [Tool] Env /packages/env labels Dec 10, 2022
@skorasaurus
Copy link
Copy Markdown
Member

Thanks for the contribution Zack.

Alex,

That is a good question. According to the broader WP documentation guidelines, commands in text should in fact be considered (this is new to me) code in text.

However, broader products, services, and organizations should be in regular text and admittedly for really popular systems that exist both as commands and products/ecosystems/organizations (docker, npm), the line can be blurry.

Copy link
Copy Markdown
Member

@danielbachhuber danielbachhuber left a comment

Choose a reason for hiding this comment

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

wp-env is mentioned with backticks here: https://github.com/WordPress/gutenberg/tree/trunk/packages/env#wp-env

I think that's good enough as prior art.

@danielbachhuber
Copy link
Copy Markdown
Member

@alexstine @skorasaurus I proposed a documentation enhancement WordPress/WordPress-Documentation-Style-Guide#23

@ndiego ndiego enabled auto-merge (squash) April 21, 2023 14:18
@t-hamano t-hamano disabled auto-merge December 8, 2023 13:37
@t-hamano
Copy link
Copy Markdown
Contributor

t-hamano commented Dec 8, 2023

Hi @zackkatz,

This PR also makes sense to me, but there seems to be a conflict. Could you please rebase on the latest trunk to merge this PR?

In the latest trunk, wp-env in this line is already wrapped in backticks, so you should just put a space after the period.

If you have also installed `wp-env` globally, running it will automatically execute the local, project-level package. Alternatively, you can execute `wp-env` via [`npx`](https://www.npmjs.com/package/npx), a utility automatically installed with `npm`.`npx` finds binaries like `wp-env` installed through node modules. As an example: `npx wp-env start --update`.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

First-time Contributor Pull request opened by a first-time contributor to Gutenberg repository [Tool] Env /packages/env [Type] Developer Documentation Documentation for developers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants