File tree 1 file changed +4
-4
lines changed
1 file changed +4
-4
lines changed Original file line number Diff line number Diff line change @@ -49,11 +49,11 @@ See also: [yaml specification](https://yaml.org/spec/1.2.2/) for how to use YAML
49
49
50
50
## Keywords
51
51
52
- ### ` doc-location `
52
+ ### ` doc_location `
53
53
54
54
Rules:
55
55
56
- 1 . The ` doc-location ` keyword can be used to use content from another file INSTEAD of the doc-comments content.
56
+ 1 . The ` doc_location ` keyword can be used to use content from another file INSTEAD of the doc-comments content.
57
57
58
58
2 . The value ` file ` must be given as a path relative to the current file.
59
59
63
63
{
64
64
/**
65
65
---
66
- doc-location : ./path.md
66
+ doc_location : ./path.md
67
67
---
68
68
*/
69
69
foo = x: x;
75
75
some nice docs!
76
76
```
77
77
78
- In this example, the ` doc-location ` directive fetches content from ` ./path.md ` treating it as if it were directly within the doc-comment.
78
+ In this example, the ` doc_location ` directive fetches content from ` ./path.md ` treating it as if it were directly within the doc-comment.
79
79
This allows tracking the reference between the source position and the markdown file, in case of external documentation.
80
80
81
81
## Extensibility
You can’t perform that action at this time.
0 commit comments