Skip to content

Commit e7fd244

Browse files
committed
fix @hint api doc
1 parent 2ffbba3 commit e7fd244

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

_posts/2016-01-04-coderoad-api.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,19 +62,20 @@ See an [example](https://github.com/coderoad/coderoad-functional-school/blob/mas
6262

6363
### `@hint`
6464

65-
*@hint* loads a string which can be used to provide hints for the user. The order of hints is important.
65+
*@hint* loads a string (or array of strings) which can be used to provide hints for the user. The order of hints is important: first in, first out.
6666

6767
```markdown
6868
@hint('A hint for the user')
69-
```
69+
@hint(['Hint 1', 'Hint 2'])
7070

71-
*@hint* may use code-blocks with syntax highlighting.
71+
*@hint* may use code-blocks with syntax highlighting, but they must be wrapped in quotes.
7272

7373
```markdown
74-
@hint(`var a = 42;`)
75-
@hint(```js
74+
@hint("Use the object `{key: val}`")
75+
@hint("`var a = 42;`")
76+
@hint("```js
7677
var a = 42;
77-
```)
78+
```")
7879
```
7980

8081
### `@action`

0 commit comments

Comments
 (0)