bitovi / bitovi/documentjs

@codestart and @codeend is failing to generate code examples

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

Description

```
@function can.Object.subset
@parent can.util
@description Returns true if an Object is a subset of another Object
@codestart
can.Object.subset({}, {foo: "bar"} ) //-> true
@codeend
@signature `can.Object.subset(subset, set, compares)`
@param {Object} subset
@param {Object} set
@param {Object} compares
@returns {Boolean} Whether or not subset is a subset of set
```

In the above example, the code within @codestart/@codeend should render as a child of the description. The code DOES NOT render at all.

Contributor guide

No contributing guide indexed for this repository

Research direction

Reproduce the documented example containing @codestart and @codeend, then trace the entry point that parses or renders those tags. Confirm that the code example appears as a child of the description and add or update coverage for this case.

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
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.