Skip to content

Commit 89bce71

Browse files
Update and rename using_help_annotations_correctly.md to using_help_annotations.md
1 parent 30181d1 commit 89bce71

2 files changed

Lines changed: 16 additions & 48 deletions

File tree

docs/using_help_annotations.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Using Help Annotations
2+
3+
## Dealing with finding Help
4+
1. Make sure you first write `github:`, so MakeCode knows to fetch a repository on GitHub
5+
2. Write the repository's name **without any spaces after writing the colon**
6+
3. Add a slash command to tell the compiler to read a specific file in the repository
7+
4. If it is a folder in a repository, write the folder's name and then another slash command
8+
5. Finally, add the file's name (**the file's path must be right or it will not be load**)
9+
6. Also, make sure to **not** add .md in the end of the file path because MakeCode already reads doc files as markdown files.
10+
11+
Here is a snippet showing how to use the helper annotation correctly.
12+
``` ts
13+
//% help=github:pxt-hardware-programming-docs/docs/_getFactoryInstance
14+
function _getFactoryInstance() { }
15+
_getFactoryInstance()
16+
```

docs/using_help_annotations_correctly.md

Lines changed: 0 additions & 48 deletions
This file was deleted.

0 commit comments

Comments
 (0)