Skip to content

Commit 3d0161b

Browse files
authored
docs: Updates documentation and examples to bring it up to date with 0.0.8 (#128)
* Adds doc comments to all record root options. * Documentation updates and separated options to a folder. * Used AI to create lots of examples. The fact that it's written by AI means its probably a lot more verbose than it could be, but it has pretty good coverage of features, and it saved me ALOT of time. * `cargo fmt`
1 parent de52d04 commit 3d0161b

18 files changed

+3761
-1449
lines changed

xmlity-derive/src/de/DeserializationGroup.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To configure the deserialization, use the `#[xgroup(...)]` attribute on the root
1111

1212
## Configuration
1313

14-
### Serialize a part of an element - `#[xgroup(...)]` on the root of a type
14+
### Deserialize a part of an element - `#[xgroup(...)]` on the root of a type
1515

1616
#### Root Options
1717

@@ -33,10 +33,10 @@ attribute_order
3333
<code>"strict"</code>, <code>"loose"</code>, <code>"none"</code>
3434
</td>
3535
<td>
36-
The accepted order of attributes.
37-
- <code>"strict"</code> - The attributes must be in the same order as the fields with no fields between them.
38-
- <code>"loose"</code> - The attributes must be in the same order as the fields, but there can be fields between them.
39-
- <code>"none"</code> - The attributes can be in any order.
36+
Set if the order of attributes is important when deserializing.<br/>
37+
- <code>"strict"</code>: The attributes must come directly after each other, and this group will try to deserialize them in one go.<br/>
38+
- <code>"loose"</code>: The order of attributes must come relative to each other, but they can be separated by other attributes outside this group.<br/>
39+
- <code>"none"</code> (default): The order of attributes is not important.
4040
</td>
4141
</tr>
4242
<!--=================================================-->
@@ -48,10 +48,10 @@ children_order
4848
<code>"strict"</code>, <code>"loose"</code>, <code>"none"</code>
4949
</td>
5050
<td>
51-
The accepted order of children.
52-
- <code>"strict"</code> - The children must be in the same order as the fields with no fields between them.
53-
- <code>"loose"</code> - The children must be in the same order as the fields, but there can be fields between them.
54-
- <code>"none"</code> - The children can be in any order.
51+
Set if the order of children is important when deserializing.<br/>
52+
- <code>"strict"</code>: The children must come directly after each other, and this group will try to deserialize them in one go.<br/>
53+
- <code>"loose"</code>: The order of children must come relative to each other, but they can be separated by other children outside this group.<br/>
54+
- <code>"none"</code> (default): The order of children is not important.
5555
</td>
5656
</tr>
5757
<!--=================================================-->

0 commit comments

Comments
 (0)