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

Docs build wrongly reports errors #684

Open
josephjclark opened this issue Jul 19, 2024 · 0 comments
Open

Docs build wrongly reports errors #684

josephjclark opened this issue Jul 19, 2024 · 0 comments

Comments

@josephjclark
Copy link
Collaborator

If you have a typedef before a signature:

/**
 * Options provided to the Asana API request
 * @typedef {Object} RequestOptions
 * ...
 */

/**
 * Make a HTTP request against the Asana API.
 * @public
 * ...
 */
export function request(path, params = {}, callback) {

The docs build will report an error:

Warning: Multiple leading comment blocks found. Discarding all but first:
...
Warning: Invalid documentation for request ✗ Stated params are '', but detected params are '["path","params","callback"]'.

Basically it ignores the ACTUAL type def.

This is totally bogus, the generated docs are fine.

A quick fix might be to use the LAST comment block, not the first?

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

No branches or pull requests

1 participant