Skip to content

Commit 5853ee2

Browse files
Update using_help_annotations_correctly.md
1 parent 9047653 commit 5853ee2

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

docs/using_help_annotations_correctly.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,41 @@ Whenever using help annotations, please see these 3 steps below.
88
4. If it is a folder in a repository, write the folder's name and then another slash command
99
5. Finally, add the file's name (**the file's path must be right or it will not be load**)
1010
6. Also, make sure to **not** add .md in the end of the file path because MakeCode already reads doc files as markdown files.
11+
7.
12+
13+
Here is a snippet showing how to use the helper annotation correctly.
14+
``` ts
15+
//% help=github:pxt-hardware-programming-docs/docs/_getFactoryInstance
16+
function _getFactoryInstance() {
17+
// No code for now, do not worry about the code right here, only the doc rendering error
18+
}
19+
_getFactoryInstance()
20+
21+
//% help=github:pxt-hardware-programming-docs/docs/allocate
22+
function allocate() {}
23+
allocate()
24+
25+
//% help=github:pxt-hardware-programming-docs/docs/binRange
26+
function binRange() {}
27+
binRange()
28+
29+
//% help=github:pxt-hardware-programming-docs/docs/analyzing_code
30+
function analyzing_code() {}
31+
analyzing_code()
32+
33+
//% help=github:pxt-hardware-programming-docs/docs/bpp
34+
function bpp() {}
35+
bpp()
36+
37+
//% help=github:pxt-hardware-programming-docs/docs/fixed-size
38+
function fixedSize() {}
39+
fixedSize()
40+
41+
//% help=github:pxt-hardware-programming-docs/docs/exportModifier
42+
function exportModifier() {}
43+
exportModifier()
44+
45+
//% help=github:pxt-hardware-programming-docs/docs/decoder
46+
function decoder() {}
47+
decoder()
48+
```

0 commit comments

Comments
 (0)