bitovi / bitovi/documentjs

Nested @option is not working correctly

Open
#173 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

Example source:

```
@property {String|{}} connection.url url
@parent can-connect.options

@option {String}

As a string.

@option {{getListData: String, getInstanceData: String}}

As an object.

@option {String} getListData abc

@option {String} getInstanceData def
```

Contributor guide

No contributing guide indexed for this repository

Research direction

No file or test is named. Start by reproducing the example source and inspect how nested @option annotations are parsed; done means the string and object forms, including getListData and getInstanceData, are documented 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.