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

Function name hover card displays double hyphen when provided in description #93

Closed
bfrymire opened this issue Jun 20, 2023 · 2 comments
Labels
🔥 bug Something isn't working 🌳 parser ⌨️ vscode The Stitch extension for VSCode

Comments

@bfrymire
Copy link

According to JSDocs:

You can add a hyphen before the description to make it more readable. Be sure to include a space before and after the hyphen.

When hovering over a function name where a parameter definition has the optional hyphen before the description, the hover card will display a double-hyphen. I'm expecting only a single hyphen to be displayed.

Code_FvRVDq2MKi

Example code:

/**
 * My first function!
 * @function helloWorld
 * @param {String} [_name="World"] - The name of the person to greet.
 * @returns {String} A greeting for the supplied name.
 */
function helloWorld(_name="World") {
    return "Hello, " + _name + "!";
}
@adam-coster
Copy link
Member

Ah, yep, should be an easy fix!

@adam-coster adam-coster added 🔥 bug Something isn't working ⌨️ vscode The Stitch extension for VSCode 🌳 parser labels Jun 20, 2023
@adam-coster adam-coster added this to the VSCode Extension MVP milestone Jun 20, 2023
@adam-coster
Copy link
Member

This will be resolved in the next release!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔥 bug Something isn't working 🌳 parser ⌨️ vscode The Stitch extension for VSCode
Projects
None yet
Development

No branches or pull requests

2 participants