Skip to content

Commit

Permalink
updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesMessinger committed Oct 7, 2018
1 parent dae2db9 commit 6f494c5
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/ref-parser.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
4 changes: 1 addition & 3 deletions docs/refs.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -127,5 +127,3 @@ $RefParser.resolve("my-schema.json")
$refs.set("schemas/people/Bruce-Wayne.json#/properties/favoriteColor/default", "black");
});
```


2 changes: 1 addition & 1 deletion docs/yaml.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
`YAML` object
The YAML object
==========================

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

0 comments on commit 6f494c5

Please sign in to comment.