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

docs(env): escape pipes in table cells #20660

Merged
merged 1 commit into from
Mar 29, 2020
Merged

docs(env): escape pipes in table cells #20660

merged 1 commit into from
Mar 29, 2020

Conversation

simono
Copy link
Contributor

@simono simono commented Mar 5, 2020

See https://github.github.com/gfm/#example-200

Description

Fixed pipes inside tables cells.

How has this been tested?

Content is now displayed correctly on the GitHub page.

Types of changes

Doc improvements.

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR.

@Soean
Copy link
Member

Soean commented Mar 5, 2020

Will the escape be a problem, when we render it on https://developer.wordpress.org/block-editor/packages/packages-env/#wp-env-json ?

@Soean Soean added [Package] Env /packages/env [Type] Developer Documentation Documentation for developers labels Mar 5, 2020
@simono
Copy link
Contributor Author

simono commented Mar 29, 2020

Will the escape be a problem, when we render it on https://developer.wordpress.org/block-editor/packages/packages-env/#wp-env-json ?

@Soean Can you give me a hint, how I can test this? I didn't found a way to generate the HTML docs.

Copy link
Member

@noisysocks noisysocks left a comment

Choose a reason for hiding this comment

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

Definitely looks better in GitHub. Thanks @simono! If it breaks wordpress.org then we should fix the parser that builds those docs pages.

@noisysocks noisysocks merged commit 6e3b72a into WordPress:master Mar 29, 2020
@github-actions github-actions bot added this to the Gutenberg 7.9 milestone Mar 29, 2020
@Soean
Copy link
Member

Soean commented Mar 30, 2020

@noisysocks Now the backslash is rendered in the handbook: https://developer.wordpress.org/block-editor/packages/packages-env/#wp-env-json

@simono simono deleted the patch-1 branch March 30, 2020 08:41
@simono
Copy link
Contributor Author

simono commented Mar 30, 2020

@noisysocks @Soean Thanks for the merge. Let me know if I can help to fix the backslashes in the handbook.

@noisysocks
Copy link
Member

I created a ticket for the parsing issue in Meta Trac: https://meta.trac.wordpress.org/ticket/5123

This is the plugin that parses the markdown, if you'd like to try your hand at writing a patch to fix the issue: https://meta.trac.wordpress.org/browser/sites/trunk/wordpress.org/public_html/wp-content/plugins/wporg-markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Package] Env /packages/env [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants