Commite7fd244

committed

fix@hint api doc

1 parent2ffbba3 commite7fd244Copy full SHA for e7fd244

File tree

-6

lines changed

-6

lines changed

Lines changed: 7 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -62,19 +62,20 @@ See an [example](https://github.com/coderoad/coderoad-functional-school/blob/mas`
`62`	`62`
`63`	`63`	###`@hint`
`64`	`64`
`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.`
`66`	`66`
`67`	`67`	```markdown
`68`	`68`	`@hint('A hint for the user')`
`69`		-```
	`69`	`+@hint(['Hint 1', 'Hint 2'])`
`70`	`70`
`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.`
`72`	`72`
`73`	`73`	```markdown
`74`		-@hint(`var a = 42;`)
`75`		-@hint(```js
	`74`	+@hint("Use the object `{key: val}`")
	`75`	+@hint("`var a = 42;`")
	`76`	+@hint("```js
`76`	`77`	`var a = 42;`
`77`		-```)
	`78`	+```")
`78`	`79`	```
`79`	`80`
`80`	`81`	###`@action`

Comments

(0)