Skip to content
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

Markdown awareness? #296

Open
callumlocke opened this issue Nov 23, 2017 · 0 comments
Open

Markdown awareness? #296

callumlocke opened this issue Nov 23, 2017 · 0 comments

Comments

@callumlocke
Copy link

callumlocke commented Nov 23, 2017

Thanks for writing this plugin. It must have saved me days of work.

I've been using the Dockblockr:Wrap lines command, but it has some limitations. If you invoke Dockblockr:Wrap lines on this:

/**
 * Here is a basic description of the add function. Here is a bit more text to make this line really, really, really long.
 *
 * - One important thing to note.
 * - Another thing to note.
 *
 * @example
 *    const foo = add(1, 2);
 *    foo; // 3
 *
 * @public
 */

...it turns into this:

/**
 * Here is a basic description of the add function. Here is a bit more text to make this line
 * really, really, really long.
 *
 * - One important thing to note. - Another thing to note.
 * @example const foo = add(1, 2); foo; // 3
 * @public
 */

The wrapping of the description paragraph is perfect. But the list is changed into a single line. Also, the indented code snippet under @example has become a single line.

It would be awesome if Docblockr had an option (not necessarily enabled by default) to interpret the contents of the comment as Markdown and only apply the wrapping logic to actual paragraphs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants