Update content-style-guide.md #4341
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
adding this official stance to the style guide
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
github-actions
bot
added
Docs team
contributing/content-style-guide.md
Outdated
| @@ -307,10 +307,10 @@ A numbered list following an H2 heading: | |||
| ## Tables | |||
| Tables provide a great way to present complex information and can help the content be more scannable for users, too. | |||
|
|
|||
| There are many ways to construct a table, like row spanning and cell splitting. Make sure the content is clear, concise, and presents well on the web page (like avoid awkward word wrapping). | |||
| There are many ways to construct a table, like row spanning and cell splitting. Make sure the content is clear, concise, and presented well on the web page (like avoiding awkward word wrapping). | |||
There was a problem hiding this comment.
We should avoid using "like" to present examples.
Suggested change
| There are many ways to construct a table, like row spanning and cell splitting. Make sure the content is clear, concise, and presented well on the web page (like avoiding awkward word wrapping). | |
| There are many ways to construct a table, such as row spanning and cell splitting. The content should be clear, concise, and presented well on the web page (for example, avoid awkward word wrapping). |
There was a problem hiding this comment.
i hear you @matthewshaver might be worth discussing with the docs team bc the style guide itself suggests using 'like' (and i was also told to use 'like', 'such as', 'for example', as opposed to 'eg' when i started).
Co-authored-by: Matt Shaver <[email protected]>
Co-authored-by: Matt Shaver <[email protected]>
mirnawong1
commented
Oct 27, 2023
|
hey @matthewshaver , thanks so much for this review! is this good to merge or are there any pending items for me to resolve? |
|
thanks so much for merging @runleonarun ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
adding this official stance to the style guide to ensure correct terminology is used