Skip to content

Conversation

@JoshuaKGoldberg
Copy link
Contributor

Right now, informative-docs isn't trimming the text it passes to are-docs-informative. The Boolean(text) check that's supposed to filter out blank text isn't accounting for whitespace. That means when there's a tag like @class, it calls the equivalent of:

areDocsInformative('\n', 'MyAmazingThing')

...which is false.

This .trim()s the text so that whitespace is ignored.

Fixes #1039.

@brettz9
Copy link
Collaborator

brettz9 commented Apr 24, 2023

Thanks for this... If you could also take a look at #1041 , @JoshuaKGoldberg ?

@brettz9 brettz9 merged commit f3faa25 into gajus:main Apr 24, 2023
@github-actions
Copy link

🎉 This PR is included in version 43.0.8 🎉

The release is available on:

Your semantic-release bot 📦🚀

@JoshuaKGoldberg JoshuaKGoldberg deleted the informative-docs-trim-descriptions branch April 25, 2023 03:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

jsdoc-informative-docs generates a report whenever you use @class

2 participants