Skip to content

Commit

Permalink
rename doc-location -> doc_location
Browse files Browse the repository at this point in the history
  • Loading branch information
hsjobeki committed Mar 22, 2024
1 parent 6217f2e commit a2e4bde
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/frontmatter.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,11 @@ See also: [yaml specification](https://yaml.org/spec/1.2.2/) for how to use YAML

## Keywords

### `doc-location`
### `doc_location`

Rules:

1. The `doc-location` keyword can be used to use content from another file INSTEAD of the doc-comments content.
1. The `doc_location` keyword can be used to use content from another file INSTEAD of the doc-comments content.

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

Expand All @@ -63,7 +63,7 @@ Rules:
{
/**
---
doc-location: ./path.md
doc_location: ./path.md
---
*/
foo = x: x;
Expand All @@ -75,7 +75,7 @@ Rules:
some nice docs!
```

In this example, the `doc-location` directive fetches content from `./path.md` treating it as if it were directly within the doc-comment.
In this example, the `doc_location` directive fetches content from `./path.md` treating it as if it were directly within the doc-comment.
This allows tracking the reference between the source position and the markdown file, in case of external documentation.

## Extensibility
Expand Down

0 comments on commit a2e4bde

Please sign in to comment.