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

Add backticks option to markdown output #84

Conversation

franklin-stripe
Copy link

Prerequisites

Put an x into the box(es) that apply:

  • This pull request fixes a bug.
  • This pull request adds a feature.
  • This pull request introduces breaking change.

For more information, see the Contributing Guide.

Description

This adds an option for markdown output to include backticks for
variable and output names. This is useful since names may include
underscores, which most markdown renderers treat as emphasis indicators.

Issues Resolved

This is a slightly different twist on handling double underscores: #48

Checklist

Put an x into all boxes that apply:

Tests

  • I have added tests to cover my changes.
  • All tests pass when I run make test.

Documentation

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

Code Style

  • My code follows the code style of this project.

This adds an option for markdown output to include backticks for
variable and output names. This is useful since names may include
underscores, which most markdown renderers treat as emphasis indicators.
@metmajer
Copy link
Member

Hi @franklin-stripe and thank you for a great looking, first contribution!

To be frank, I do prefer to follow up on @sjauld's work (in progress) in #63. Back-ticking does have its upsides, such as not having to take care of escaping, but it may as well be uneasy on the eye if you browse the table for information and have to search through varying fonts and styles. Cheers!

@metmajer metmajer closed this Oct 23, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants