bitovi / bitovi/documentjs

better warning for assigning arg names to non-function types

Open
#117 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
598
Forks
371
PR merge metrics
No merged PRs in 30d

Description

Something like:

```
@param {can.compute.asyncComputer} computed(newVal)
```

only logs:

```
"WARNING! "+obj.types[0].name+" does not appear to be a function."+
" If it is a typedef, you can not specify the params to the typedef. "
```

This should let someone know where this is happening. Perhaps throwing an error that will report.

Contributor guide

No contributing guide indexed for this repository

Research direction

Reproduce the warning with the documented `@param {can.compute.asyncComputer} computed(newVal)` example, then locate the code that emits the non-function warning. Determine how the warning can identify where the invalid parameter assignment occurs, and confirm with maintainers whether reporting or throwing is expected before defining done.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.