gutenberg icon indicating copy to clipboard operation
gutenberg copied to clipboard

Add a few code backticks

Open zackkatz opened this issue 3 years ago • 3 comments

What?

Just very minor formatting.

Why?

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

zackkatz avatar Dec 09 '22 21:12 zackkatz

:wave: 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.

github-actions[bot] avatar Dec 09 '22 21:12 github-actions[bot]

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.

skorasaurus avatar Dec 26 '22 19:12 skorasaurus

@alexstine @skorasaurus I proposed a documentation enhancement https://github.com/WordPress/WordPress-Documentation-Style-Guide/pull/23

danielbachhuber avatar Jan 30 '23 12:01 danielbachhuber

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.

https://github.com/WordPress/gutenberg/blob/d87092cae0dda2284ffcea05ef768bc097497579/packages/env/README.md#L47

t-hamano avatar Dec 08 '23 13:12 t-hamano