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.

Sign up for GitHub

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

Jump to bottom

Some values in generated Markdown get double backticks #304

Closed
danielparks opened this issue Sep 23, 2022 · 0 comments · Fixed by #305
Closed

Some values in generated Markdown get double backticks #304

danielparks opened this issue Sep 23, 2022 · 0 comments · Fixed by #305
Assignees
@chelnak
Labels
bug

Comments

@danielparks
Copy link
Contributor

Describe the Bug

Some values in generated Markdown are wrapped with double backticks instead of single.

As far as I can tell this doesn’t affect the HTML rendering on GitHub or Forge.

Expected Behavior

All values should be wrapped with single backticks.

Steps to Reproduce

Steps to reproduce the behavior:

❯ cat test.pp     
class test ( $param = true ) {}
❯ puppet strings generate --format markdown test.pp &>/dev/null ; grep '^Default value' REFERENCE.md
Default value: ``true``

Environment

  • ruby 3.1.2p20
  • macOS 12.6.0
  • Current main branch (dba16ed)

I’ll submit a PR for this shortly.
danielparks added a commit to danielparks/puppet-strings that referenced this issue Sep 23, 2022
@danielparks
(puppetlabs#304) Fix double backticks in Markdown
9602878 
Previously, some values in generated Markdown were wrapped in double
backticks instead of single backticks. This removes the code that added
the extra backticks.
@danielparks danielparks mentioned this issue Sep 23, 2022
Merged
danielparks added a commit to danielparks/puppet-strings that referenced this issue Sep 26, 2022
@danielparks
(puppetlabs#304) Fix double backticks in Markdown
8fffce2 
Previously, some values in generated Markdown were wrapped in double
backticks instead of single backticks. This removes the code that added
the extra backticks.
@chelnak chelnak self-assigned this Sep 26, 2022
@chelnak chelnak linked a pull request Sep 26, 2022 that will close this issue
(#304) Fix double backticks in Markdown #305
Merged
chelnak pushed a commit to danielparks/puppet-strings that referenced this issue Sep 26, 2022
@danielparks @chelnak
(puppetlabs#304) Fix double backticks in Markdown
c5485cd 
Previously, some values in generated Markdown were wrapped in double
backticks instead of single backticks. This removes the code that added
the extra backticks.
chelnak added a commit that referenced this issue Sep 26, 2022
@chelnak
Merge pull request #305 from danielparks/fix_double_backticks
c53a306 
(#304) Fix double backticks in Markdown
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chelnak chelnak

Labels
bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

(#304) Fix double backticks in Markdown danielparks/puppet-strings
2 participants
@danielparks @chelnak