Skip to content

Commit ad5b741

Browse files
committed
Update docs for next release
1 parent 8ca0030 commit ad5b741

File tree

3 files changed

+26
-6
lines changed

3 files changed

+26
-6
lines changed

docs/docs/schema.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,14 @@ layout: page.html
33
title: Schema
44
---
55

6-
This document will be completed in future.
7-
8-
Meanwhile, all the following things have been documented in React JSON Form's sister
9-
project: [django-jsonform](https://django-jsonform.readthedocs.io/en/latest/).
6+
<div class="alert alert-info">
7+
<p><strong>Note</strong></p>
8+
<p>This document will be completed in future.</p>
9+
<p>
10+
Meanwhile, all the following things have been documented in React JSON Form's sister
11+
project: <a href="https://django-jsonform.readthedocs.io/en/latest/">django-jsonform<a>.
12+
</p>
13+
</div>
1014

1115
## Schema guide
1216

docs/docs/usage/node.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,10 +168,26 @@ let errorMap = {
168168
'0': 'This is required',
169169

170170
// first item > object > property: name
171-
'0-name': 'This is required'
171+
// (see note below about the section sign "§")
172+
'0§name': 'This is required'
172173
}
173174
```
174175

176+
<div class="alert alert-info">
177+
<p><strong>The section sign (§)</strong></p>
178+
<p>
179+
The section sign (<code>§</code>) is used as the separator symbol for
180+
doing nested items lookup.
181+
</p>
182+
<p>
183+
Earlier, the hyphen (<code>-</code>) was used but that complicated things
184+
when the the schema object properties (i.e. field names) also had a hyphen
185+
in them. Then it became impossible to determine whether the hyphen was the
186+
separator or part of the key.
187+
</p>
188+
</div>
189+
190+
175191
##### `DataValidator` API reference
176192

177193
##### Constructor

docs/static/js/playground.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)