Remove extra backslashes from code snippets #3139
Merged
+3
−14
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
See generated changes |
alextwoods
reviewed
Nov 5, 2024
| @@ -11,8 +11,6 @@ module AsymmetricCredentials | |||
|
|
|||
| N_MINUS_2 = 0xFFFFFFFF00000000FFFFFFFFFFFFFFFFBCE6FAADA7179E84F3B9CAC2FC632551 - 2 | |||
|
|
|||
| # @param [String] :access_key_id | |||
There was a problem hiding this comment.
Why remove these? They are still the correct paramters here?
There was a problem hiding this comment.
The module is API private and these were wrong. These are positional parameters but they were symbolized name, so it produced a warning. I just deleted them because it's clear what they are (and API private).
| nil | ||
| end | ||
| end | ||
|
|
||
| def generated_examples(operation, api) |
There was a problem hiding this comment.
I don't think so...
| @@ -118,10 +118,6 @@ def html_to_markdown(html, options = {}) | |||
| if html | |||
| html = "<p>#{html}</p>" unless html.match(/<\w+>/) | |||
|
|
|||
| # unescaped curly braces cause YARD errors, they are interpreted | |||
| # as code links. | |||
| html = html.gsub('{', "\\{").gsub('}', "\\}") | |||
There was a problem hiding this comment.
could we take an escape_curly_braces option and pass it only when this is called for code docs?
There was a problem hiding this comment.
That doesn't fix inline code snippets in the documentation. This applies on the whole block of documentation text.
alextwoods
approved these changes
Nov 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #3132
We were addressing Yard warnings by escaping backslashes, but this also applied to code snippets. I tried a solution where we only escaped when not in a code section but this approach failed. This is because we have a multi-tier doc system with html -> markdown (rdiscount) -> yard, each handling escaping differently. This approach fixes the docs visibly but we will have warning outputs when curly braces are used outside of code blocks. This doesn't happen often, a majority of docs use code blocks.