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
Multiline comments are trimmed too aggressively #85
Labels
Comments
issuehunt-oss
bot
added
the
💵 Funded on Issuehunt
This issue has been funded on Issuehunt
label
Jul 29, 2019
@issuehunt has funded $10.00 to this issue.
|
hey @ChristianKienle. How are you? Hope that well. I just create a PR that solves the problem :) |
@maykefreitas super cool. :D Can't wait for it to get merged. ❤️ |
@ChristianKienle hope that it help you :) |
|
@HcySunYang has rewarded $9.00 to @maykefreitas. See it on IssueHunt
|
issuehunt-oss
bot
added
🎁 Rewarded on Issuehunt
This issue has been rewarded on Issuehunt
and removed
💵 Funded on Issuehunt
This issue has been funded on Issuehunt
labels
Aug 3, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description
We are currently adopting vuese in our component library. So far it works pretty well – thank you for this wonderful project.
Some of our components are a bit more complex – for those components we have written guides using plain markdown (for example, our table component comes with such a guide) which explain step by step how this component works. In addition to those guide we also have API documentation generated by using @vuese/parser. Sometimes we also want to include short examples in the API documentation that show how to use the component. Just to avoid developers going back and forth between the guides and API documentation too much. The example below shows such an example:
Our own renderer uses the component description array produces by vuese/parser, joins it using
\n
and then feeds it into our markdown-component that also does syntax highlighting.Unfortunately every line in the component description array is trimmed which means that the intention of our example code is gone making it hard to read.
To Reproduce
Steps to reproduce the behavior:
Expected behavior
I expect that multiline comments are not trimmed from both sides.
Screenshots
See above
Which version do you use:
latest as of this moment
Additional information
I suggest either making the trimming lest aggressive (at least for multiline comments) or add the untrimmed comments as an additional property: "rawCommentDescription" or something like that. This way we could simply use that.
IssueHunt Summary
maykefreitas has been rewarded.
Backers (Total: $10.00)
Submitted pull Requests
Tips
IssueHunt has been backed by the following sponsors. Become a sponsor
The text was updated successfully, but these errors were encountered: