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

Promise generics show with object (dot) notation #276

Open
jjeff opened this issue Feb 27, 2022 · 1 comment
Open

Promise generics show with object (dot) notation #276

jjeff opened this issue Feb 27, 2022 · 1 comment
Labels
more info More info required to reproduce

Comments

@jjeff
Copy link

jjeff commented Feb 27, 2022

I'm using jsdoc-to-markdown to generate the README file for electron-playwright-helpers. However the JSDoc definitions for returned Promise generics such as @returns {Promise<boolean>} leads to output which resembles this: => Promise.<boolean> note the "." before the bracket.

Is this a bug? Is there a way to remove the dot?

I've also added the @filfil and @reject values, but they're still not as clear as functionName(arg) => Promise<boolean> as a summary.

@75lb
Copy link
Member

75lb commented Aug 26, 2024

could you post some code and a command I can run please, so I can see and debug the issue.

@75lb 75lb added the more info More info required to reproduce label Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
more info More info required to reproduce
Development

No branches or pull requests

2 participants