Make list of skipped suggestions an expandable detail #486
Labels
priority: p3
Desirable enhancement or fix. May not be included in next release.
type: feature request
‘Nice-to-have’ improvement, new feature or different behavior or design.
Thanks for stopping by to let us know something could be better!
Is your feature request related to a problem? Please describe.
In the case of a
review
such as here a long list of line numbers is added in a comment.This list is nice information but hard to browse past when I don't care about the information, which is most of the time.
I just want to review, I'm not going to manually navigate to any of those lines.
Describe the solution you'd like
The html tags
<summary>
and<detail>
should be used to allow users to expand the list on demand but not make the info take up space until then. Examples can be found here:https://gist.github.com/scmx/eca72d44afee0113ceb0349dd54a84a2
=> something like this:
'<details><summary>Some suggestions could not be made:</summary>\n\n' + {all the file and line info} + '\n\n</details>'
would look something like this:
Start of example
Some suggestions could not be made:
src/main/java/tools/jackson/core/Base64Variant.java
src/main/java/tools/jackson/core/Base64Variants.java
src/main/java/tools/jackson/core/JacksonException.java
src/main/java/tools/jackson/core/JsonGenerator.java
Describe alternatives you've considered
Users memorize the key combination to scroll past an entire comment.
Additional context
Example of such a way too long comment(same link as the first one, above): timo-a/jackson-core#2 (review)
Relevant section of code in this repo:
code-suggester/src/github/review-pull-request.ts
Lines 41 to 48 in f091b69
The text was updated successfully, but these errors were encountered: