Documentation generator truncates config descriptions #692
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
rock3r
reviewed
Jan 14, 2018
| @@ -92,9 +92,10 @@ internal class RuleVisitor : DetektVisitor() { | |||
| valid | |||
| } | |||
| .map { | |||
| val name = it.split("-")[0].trim() | |||
| val delimiterIndex = it.indexOf('-') | |||
| val name = it.substring(0, delimiterIndex-1) | |||
There was a problem hiding this comment.
Missing spaces around the -: delimiterIndex-1
There was a problem hiding this comment.
There is a trim(). It doesn't matter.
There was a problem hiding this comment.
I'm talking about your code at this line, not the documentation it generates. The code needs a reformatting.
| val defaultValue = configurationDefaultValueRegex.find(it)?.groupValues?.get(1)?.trim() ?: "" | ||
| val description = it.split("-")[1] | ||
| val description = it.substring(delimiterIndex+1) |
There was a problem hiding this comment.
Missing spaces around the +: delimiterIndex+1
Mauin
approved these changes
Jan 15, 2018
vanniktech
approved these changes
Jan 16, 2018
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.
This should fix #691