From 6f494c561d2304328a3cd66418e2dec0c9b44a3a Mon Sep 17 00:00:00 2001 From: James Messinger Date: Sun, 7 Oct 2018 15:01:53 -0500 Subject: [PATCH] updated documentation --- docs/ref-parser.md | 2 +- docs/refs.md | 4 +--- docs/yaml.md | 2 +- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/ref-parser.md b/docs/ref-parser.md index 24adab7b..cc12fd94 100644 --- a/docs/ref-parser.md +++ b/docs/ref-parser.md @@ -1,4 +1,4 @@ -`$RefParser` class +The $RefParser class ========================== This is the default export of JSON Schema $Ref Parser. You can creates instances of this class using `new $RefParser()`, or you can just call its [static methods](README.md#class-methods-vs-instance-methods). diff --git a/docs/refs.md b/docs/refs.md index 02a0a10a..51751ffc 100644 --- a/docs/refs.md +++ b/docs/refs.md @@ -1,4 +1,4 @@ -`$Refs` class +The $Refs class ========================== When you call the [`resolve`](ref-parser.md#resolveschema-options-callback) method, the value that gets passed to the callback function (or Promise) is a `$Refs` object. This same object is accessible via the [`parser.$refs`](ref-parser.md#refs) property of `$RefParser` objects. @@ -127,5 +127,3 @@ $RefParser.resolve("my-schema.json") $refs.set("schemas/people/Bruce-Wayne.json#/properties/favoriteColor/default", "black"); }); ``` - - diff --git a/docs/yaml.md b/docs/yaml.md index 8ff4945f..6e4ffcc9 100644 --- a/docs/yaml.md +++ b/docs/yaml.md @@ -1,4 +1,4 @@ -`YAML` object +The YAML object ========================== This object provides simple YAML parsing functions. JSON Schema $Ref Parser uses this object internally