Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: now-incorrect note regarding miniyaml definitions beginning with '^' #20

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions src/modding/miniyaml/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,13 @@ This node _is indented 1 level more than `E1`_ so it is a child of the `E1` node
should be inserted right where this node is (so this `Inherits: ^Solder` node
would be replaced with `^Soldier`'s tree), effectively merging the two trees.

Also note that `^` _is not special_, it is purely convention that indicates
the referenced node is a "template", meaning it is only meant to be inherited
from, not used in any other way.
Also note that `^` indicates the referenced definition is a
template/partial/abstract, meaning it can only be inherited from, not used
in any other way.

If that doesn't make sense now that is fine! We will come back to this in a
future chapter.

<!--
TODO: Verify that keys starting with `^` aren't given special treatment
-->

---

```yml
Expand Down