Skip to content

Commit bdb8351

Browse files
JamesMessingerJamesMessinger
committed
Added placeholder text to incomplete docs pages
1 parent ba64dfe commit bdb8351

File tree

9 files changed

+42
-91
lines changed

9 files changed

+42
-91
lines changed

‎docs/anchor.md

Lines changed: 2 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -41,94 +41,5 @@ console.log(`This anchor is in ${anchor.resource.uri.href}`);
4141

4242

4343

44-
45-
46-
NOT FINISHED
47-
48-
NOT FINISHED
49-
50-
NOT FINISHED
51-
52-
NOT FINISHED
53-
54-
NOT FINISHED
55-
56-
NOT FINISHED
57-
58-
NOT FINISHED
59-
60-
NOT FINISHED
61-
62-
NOT FINISHED
63-
64-
NOT FINISHED
65-
66-
67-
68-
69-
70-
71-
72-
73-
74-
75-
76-
### `uri` <small>([`URL` object](https://developer.mozilla.org/en-US/docs/Web/API/URL))</small>
77-
The absolute, canonical [UR**I** (Uniform Resource Identifier)](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier) of the resource. Note that this does _not_ necessarily correspond to a physical file on disk, or a [UR**L** (Uniform Resource Locator)](https://en.wikipedia.org/wiki/URL) that can be downloaded.
78-
79-
```javascript
80-
console.log(resource.uri.href);
81-
```
82-
83-
84-
### `locationInFile` <small>([`Pointer` object](pointer.md))</small>
85-
A [JSON Pointer](https://tools.ietf.org/html/rfc6901) that indicates the resource's location in the file.
86-
87-
```javascript
88-
console.log(`This resource is at ${resource.locationInFile.path} in ${resource.file}`);
89-
```
90-
91-
92-
### `data` <small>(anything)</small>
93-
The resource data. This can be _any_ JavaScript value, but will usually be one of the following:
94-
95-
- `object`<br>
96-
If the resource is a JSON Schema document that has already been parsed.
97-
98-
- `string`<br>
99-
If the resource is in text-based data that has not yet been parsed.
100-
This includes JSON, YAML, HTML, SVG, CSV, plain-text, etc.
101-
102-
- `ArrayBuffer`<br>
103-
If the resource contains binary data, such as an image.
104-
105-
```javascript
106-
resource.data = {
107-
$id: "person",
108-
title: "Person",
109-
properties: {
110-
name: { type: "string" },
111-
age: { type: "integer" },
112-
}
113-
};
114-
```
115-
116-
117-
### `anchors` <small>(array of [`Anchor` objects](anchor.md))</small>
118-
An array of all the [JSON Schema anchors](http://json-schema.org/draft/2019-09/json-schema-core.html#anchor) (i.e. `$anchor`) in the resource.
119-
120-
```javascript
121-
for (let anchor of resource.anchors) {
122-
console.log(anchor.uri.href);
123-
}
124-
```
125-
126-
127-
### `references` <small>(iterable of [`Reference` objects](reference.md))</small>
128-
An array of all the [JSON Schema references](http://json-schema.org/draft/2019-09/json-schema-core.html#ref) (i.e. `$ref`) in the resource.
129-
130-
```javascript
131-
for (let ref of resource.references) {
132-
console.log(`${ref.locationInFile.path} points to ${ref.targetURI.href}`);
133-
}
134-
```
44+
> ### ⚠ INCOMPLETE DOCS ⚠
45+
> There's more to this object, but the rest of this page has not yet been written.

‎docs/error-handling.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Error Handling
2+
======================
3+
4+
> ### ⚠ INCOMPLETE DOCS ⚠
5+
> This documentation has not been written yet

‎docs/options.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Options
2+
======================
3+
4+
> ### ⚠ INCOMPLETE DOCS ⚠
5+
> This documentation has not been written yet

‎docs/parse-file.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Parsing Files
2+
======================
3+
4+
> ### ⚠ INCOMPLETE DOCS ⚠
5+
> This documentation has not been written yet

‎docs/pointer.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
`Pointer` Object
2+
======================
3+
4+
> ### ⚠ INCOMPLETE DOCS ⚠
5+
> This documentation has not been written yet

‎docs/read-file.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Reading Files
2+
======================
3+
4+
> ### ⚠ INCOMPLETE DOCS ⚠
5+
> This documentation has not been written yet

‎docs/reference.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
`Reference` Objecct
2+
======================
3+
4+
> ### ⚠ INCOMPLETE DOCS ⚠
5+
> This documentation has not been written yet

‎docs/resolution.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Resolving Resources
2+
======================
3+
4+
> ### ⚠ INCOMPLETE DOCS ⚠
5+
> This documentation has not been written yet

‎docs/schema-error.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
`SchemaError` Object
2+
======================
3+
4+
> ### ⚠ INCOMPLETE DOCS ⚠
5+
> This documentation has not been written yet

0 commit comments

Comments
 (0)