From 4fd52067db8cabf9e6c68f6b7b1a0eecbb1c3193 Mon Sep 17 00:00:00 2001 From: Jonathan Cobb Date: Thu, 17 Dec 2020 17:53:05 -0500 Subject: [PATCH] update docs --- docs/complex_example.md | 3 --- docs/running.md | 5 +++++ 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/complex_example.md b/docs/complex_example.md index 983648c..04dd733 100644 --- a/docs/complex_example.md +++ b/docs/complex_example.md @@ -8,9 +8,6 @@ If you have other JSON-aware tools that need to read JVLC files, you may not want to use this comment syntax. The `asset` and `operation` JSON objects also support a `comment` field, which can be used as well. -Doug C: I promise these will always be just comments; jvc will never -use [comments as parsing directives or otherwise break interoperability](https://web.archive.org/web/20120507155137/https://plus.google.com/118095276221607585885/posts/RK8qyGVaGSr) (note: disable javascript to view this link) - ```js { "assets": [ diff --git a/docs/running.md b/docs/running.md index 4279334..c8ac8ac 100644 --- a/docs/running.md +++ b/docs/running.md @@ -47,6 +47,11 @@ Unlike most JSON, comments *are* allowed in JVC spec files: * A line comment starts with `//` and continue to the end of the line * A multi-line block starts with `/*` and ends with `*/` +Doug C: I promise that in jvc comments will always be just comments; +jvc will never use +[comments as parsing directives or otherwise break interoperability](https://web.archive.org/web/20120507155137/https://plus.google.com/118095276221607585885/posts/RK8qyGVaGSr) +(note: disabling javascript required to view link) + ## Writing a JVC Spec The easiest way to write a spec is to copy one of the [test specs](../src/test/resources/tests) and edit it.