Skip to content

fix render bug for good-first-issues:>2 javascript #25293

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

Merged
merged 2 commits into from
May 1, 2023

Conversation

danhood
Copy link
Contributor

@danhood danhood commented Apr 28, 2023

These backticks cause the embedded > to pass through escaped and be rendered not as a > symbol, but rather > in the HTML output. This change corrects that and also brings it inline with the other example in the same table (no backticks).

Why:

Closes: 25292

What's being changed (if available, include any code snippets, screenshots, or gifs):

Simply removed the conflicting backticks to bring it inline with other example in table and fix rendering bug.

Check off the following:

  • I have reviewed my changes in staging (look for the "Automatically generated comment" and click the links in the "Preview" column to view your latest changes).
  • For content changes, I have completed the self-review checklist.

These backticks cause the embedded `>` to pass through escaped and be rendered *not* as a `>` symbol, but rather `>` in the HTML output. This change corrects that and also brings it inline with the other example in the same table (no backticks).
@welcome
Copy link

welcome bot commented Apr 28, 2023

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 Apr 28, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Apr 28, 2023

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
search-github/searching-on-github/searching-for-repositories.md fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae
fpt
ghec
ghes@ 3.8 3.7 3.6 3.5 3.4
ghae

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

@cmwilson21
Copy link
Contributor

@danhood Thank you for opening a PR and linking it to your issue! ✨

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review search-github Related to GitHub search and removed triage Do not begin working on this issue until triaged by the team labels May 1, 2023
Copy link
Contributor

@sabrowning1 sabrowning1 left a comment

Choose a reason for hiding this comment

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

👋🏼 @danhood, thanks for catching this! Your fix looks great, I'll get this merged shortly 🚀 thank you for your help maintaining our docs! ✨

@sabrowning1 sabrowning1 added this pull request to the merge queue May 1, 2023
Merged via the queue into github:main with commit 998f84c May 1, 2023
@github-actions
Copy link
Contributor

github-actions bot commented May 1, 2023

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

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 search-github Related to GitHub search waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rendering bug due to backtick and > escaping
3 participants