Skip to content

Commit a2e4bde

Browse files
committed
rename doc-location -> doc_location
1 parent 6217f2e commit a2e4bde

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

doc/frontmatter.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,11 @@ See also: [yaml specification](https://yaml.org/spec/1.2.2/) for how to use YAML
4949

5050
## Keywords
5151

52-
### `doc-location`
52+
### `doc_location`
5353

5454
Rules:
5555

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.
5757

5858
2. The value `file` must be given as a path relative to the current file.
5959

@@ -63,7 +63,7 @@ Rules:
6363
{
6464
/**
6565
---
66-
doc-location: ./path.md
66+
doc_location: ./path.md
6767
---
6868
*/
6969
foo = x: x;
@@ -75,7 +75,7 @@ Rules:
7575
some nice docs!
7676
```
7777

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.
7979
This allows tracking the reference between the source position and the markdown file, in case of external documentation.
8080

8181
## Extensibility

0 commit comments

Comments
 (0)