bitovi / bitovi/documentjs

function in param name causes problems

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

Description

Something like this:

```
@signature `can-EVENT='{functionKey [argKey..] [hashName=hashKey..]}'`

Specify a callback function to be called on a particular event. You can create your own special event types.

@param {String} EVENT A event name like `click` or `keyup`. If you are
using jQuery, you can listen to jQuery special events too.

@param {can.stache.key} functionKey A named key value in the current scope. The value
should be a function.

@param {can.stache.key} [argKey...] Blah
```

The functionKey argument is not displayed right.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reproducing the documented @signature example containing functionKey, then inspect the documentjs parsing and rendering path for that argument. Compare the displayed functionKey argument with the source example; done means the argument is displayed correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
documentation
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.