fix: escape brackets in documentation traits #401
Merged
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
ianbotsf
requested changes
Jun 9, 2021
Comment on lines
32
to
34
| // KDoc comments use inline markdown. Replace square brackets with escaped equivalents so that they | ||
| // are not rendered as invalid links | ||
| private fun sanitize(str: String): String = str.replace(Regex("(\\[)(.*)(\\])"), "[$2]") |
There was a problem hiding this comment.
Correctness: This regex won't capture nested braces or multiple braces on a line. For example:
a [ b [ c ] d ]→a [ b [ c ] d ]a [ b ] c [ d ]→a [ b ] c [ d ]
This won't capture unpaired braces either, but I'm unclear if those are a problem or not.
There was a problem hiding this comment.
Unpaired braces shouldn't be a problem as far as I know since they won't be processed as inline markdown links.
aajtodd
force-pushed
the
fix-generated-kdoc
branch
from
732dbbb
to
00ac1ba
Compare
ianbotsf
approved these changes
Jun 10, 2021
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.
Issue #, if available:
fixes awslabs/aws-sdk-kotlin#153
Description of changes:
Added a new model preprocessor that sanitizes all
@documentationtraits and replaces all square bracket pairs with html escaped equivalents. Otherwise square brackets are treated as inline markdown in KDoc (which apparently can cause compile to fail if the link is an "invalid" identifier)By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.