Add a few code backticks#46445
Conversation
|
👋 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. |
|
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. |
danielbachhuber
left a comment
There was a problem hiding this comment.
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.
|
@alexstine @skorasaurus I proposed a documentation enhancement WordPress/WordPress-Documentation-Style-Guide#23 |
|
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, gutenberg/packages/env/README.md Line 47 in d87092c |
What?
Just very minor formatting.
Why?
There was a space missing between sentences and missing code ticks.