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

Bug with split on large single token markup #48

Open
jfroelich opened this issue Jan 2, 2021 · 0 comments
Open

Bug with split on large single token markup #48

jfroelich opened this issue Jan 2, 2021 · 0 comments
Labels
bug Something isn't working

Comments

@jfroelich
Copy link
Owner

For example:

/**
 * @idontknowhyanyonewoulddothisbutiguessitcanhappenthisiscrazylong
 */

In this case the jsdoc tag gets split. we should never mutate a jsdoc tag itself. We should bail.

Then there is a separate but very similar issue.

/**
 * @sometag someverylongsingletokenherethatcausesoverflow
 */

Right now the behavior is to move the tag text after the tax to the next line. Is that correct? The tag is being treated as a token itself. Maybe we should be detecting jsdoc lines and tokenizing them differently. Maybe the appropriate behavior is to hard break the large token in the tag's description area? Because I think we if move the token to the next line, that breaks the link between the tag and the description sometimes? Uncertain.

@jfroelich jfroelich added the bug Something isn't working label Jan 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant