Skip to content

Commit 6f494c5

Browse files
updated documentation
1 parent dae2db9 commit 6f494c5

3 files changed

Lines changed: 3 additions & 5 deletions

File tree

docs/ref-parser.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
`$RefParser` class
1+
The $RefParser class
22
==========================
33

44
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).

docs/refs.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
`$Refs` class
1+
The $Refs class
22
==========================
33

44
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")
127127
$refs.set("schemas/people/Bruce-Wayne.json#/properties/favoriteColor/default", "black");
128128
});
129129
```
130-
131-

docs/yaml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
`YAML` object
1+
The YAML object
22
==========================
33

44
This object provides simple YAML parsing functions. JSON Schema $Ref Parser uses this object internally

0 commit comments

Comments
 (0)