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

Updated Underline Syntax Example: Corrected the output example for the underline text style. #35214

Closed
wants to merge 3 commits into from

Conversation

WyrdScop
Copy link

@WyrdScop WyrdScop commented Nov 7, 2024

This pull request includes a small change to the content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md file. The change corrects the rendering of underlined text in the Markdown syntax documentation.

  • Corrected the rendering of underlined text in the Markdown syntax documentation.

Copy link

welcome bot commented Nov 7, 2024

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 7, 2024
Copy link
Contributor

github-actions bot commented Nov 7, 2024

Automatically generated comment ℹ️

This comment is automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.14 3.13 3.12 3.11 3.10

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@Booi5538

This comment was marked as spam.

@github github deleted a comment from SirJosh1987 Nov 7, 2024
@nguyenalex836
Copy link
Contributor

@WyrdScop Thank you for submitting a PR! ✨

Upon review, our team found the change currently being proposed does not impact the example in a favorable / significant way 💛 though we do appreciate the effort to improve the example!

Instead, we wanted to propose moving the “underline” row above the superscript and subscript rows (and leave the actual content of the row as is), so the table looks a bit neater overall. If you are able to make this proposed change instead, we'd be happy to get this merged 🙇

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team more-information-needed More information is needed to complete review get started Content related to "Getting Started" doc set and removed triage Do not begin working on this issue until triaged by the team labels Nov 7, 2024
@WyrdScop WyrdScop closed this Nov 8, 2024
@WyrdScop WyrdScop deleted the patch-1 branch November 8, 2024 02:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team get started Content related to "Getting Started" doc set more-information-needed More information is needed to complete review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants