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

(#304) Fix double backticks in Markdown #305

Merged
merged 1 commit into from
Sep 26, 2022

Conversation

danielparks
Copy link
Contributor

Previously, some values in generated Markdown were wrapped in double backticks instead of single backticks. This removes the code that added the extra backticks.

See #304.

@danielparks danielparks requested a review from a team as a code owner September 23, 2022 12:36
@binford2k
Copy link
Contributor

are there other parts of the codebase that might be affected by this?

@danielparks
Copy link
Contributor Author

I don’t think so. It appears that the value_string function was added (1374b67) before backticks were used for all values, and then it was left in place (07ef004). I removed all calls to it.

It’s possible that some of the litmus acceptance tests will start failing because of this, but I didn’t find any tests for double backticks, or that called value_string directly. Unfortunately, it’s pretty easy to accidentally generate Ruby code that doesn’t show up in a search for such things.

Also unfortunately, the litmus tests seem to be broken both here and on my machine. :( I got Litmus working in my own module with vagrant, but it took a lot of digging, so I’m not terribly optimistic that will be easy to figure out without an expert.

@chelnak chelnak linked an issue Sep 26, 2022 that may be closed by this pull request
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 force-pushed the fix_double_backticks branch from 8fffce2 to c5485cd Compare September 26, 2022 08:18
@chelnak chelnak merged commit c53a306 into puppetlabs:main Sep 26, 2022
@chelnak chelnak self-assigned this Sep 26, 2022
@chelnak chelnak added the bug label Sep 26, 2022
@danielparks danielparks deleted the fix_double_backticks branch September 26, 2022 08:29
@chelnak chelnak added bugfix and removed bug labels Sep 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Some values in generated Markdown get double backticks
3 participants