Skip to content

auto-generate documentation from JSDoc strings for timelines #38

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

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
2,288 changes: 2,249 additions & 39 deletions package-lock.json

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,15 @@
"changeset:version": "changeset version",
"changeset:publish": "changeset publish"
},
"dependencies": {},
"devDependencies": {
"@changesets/changelog-github": "^0.4.0",
"@changesets/cli": "^2.16.0",
"@jspsych/config": "^3.2.2",
"husky": "^7.0.1",
"import-sort-style-module": "^6.0.0",
"jsdoc": "^4.0.4",
"jsdoc-plugin-typescript": "^3.2.0",
"jsdoc-to-markdown": "^9.1.1",
"lint-staged": "^11.1.2",
"prettier": "^2.3.2",
"prettier-plugin-import-sort": "^0.0.7"
Expand Down
38 changes: 38 additions & 0 deletions packages/new-timeline/hearts-and-flowers/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
**@jspsych-timelines/hearts-and-flowers**

***

# hearts-and-flowers

## Overview

Implementation of the hearts and flowers task, which tests executive function.

## Loading

### In browser

```html
<script src="https://unpkg.com/@jspsych-timelines/hearts-and-flowers">
```

### Via NPM

```
npm install @jspsych-timelines/hearts-and-flowers
```

```js
import { createTimeline, timelineUnits, utils } from "@jspsych-timelines/hearts-and-flowers"
```

## Compatibility

`@jspsych-timelines/hearts-and-flowers` requires jsPsych v8.0.0 or later.

## Documentation

### createTimeline

<!--createTimeline Description-->

3 changes: 3 additions & 0 deletions packages/new-timeline/hearts-and-flowers/assets/blank-icon.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export const blankIconSvg = `<svg width="240" height="240" viewBox="0 0 240 240" xmlns="http://www.w3.org/2000/svg">
<rect width="240" height="240" fill="none" stroke="none" stroke-width="2"/>
</svg>`;
14 changes: 14 additions & 0 deletions packages/new-timeline/hearts-and-flowers/assets/flower-icon.js

Large diffs are not rendered by default.

5 changes: 5 additions & 0 deletions packages/new-timeline/hearts-and-flowers/assets/heart-icon.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading