Skip to content

Commit c1a7616

Browse files
update to release notes
1 parent 95febcc commit c1a7616

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

RELEASE.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ Also included is support for:
1010
- increased testing of operators
1111
- generating Python across multiple namespaces
1212

13-
# Reading From and Writing To a String
13+
## Reading From and Writing To a String
1414

1515
The generated Python code can deserialize and serialize an object.
1616

17-
## Deserializing from a string
17+
### Deserializing from a string
1818

1919
To deserialize from a string and create a object of the model specified in the string invoke the function:
2020

@@ -31,9 +31,11 @@ To deserialize from a string and create a object of the model specified in the s
3131
Returns:
3232
BaseModel: The Rune model.
3333

34-
To serialize from an object ("[obj]") of a generated class, invoke the function:
34+
### Serialize to a string
3535

36-
`[obj].rune_serialize` with the following parameters:
36+
To serialize from a Rune object ("obj"), invoke the function:
37+
38+
`obj.rune_serialize` with the following parameters:
3739

3840
validate_model (bool, optional): Validate that the model passes all Rune defined constraings prior to serialization. Setting to False allows serialization of an invalid Model. Defaults to True.
3941

@@ -63,7 +65,5 @@ To serialize from an object ("[obj]") of a generated class, invoke the function:
6365

6466
exclude_none (bool, optional): Determines whether to exclude fields that have a value of `None`. If True, fields set to None will be included. Defaults to False.
6567

66-
6768
Returns:
6869
A string.
69-

0 commit comments

Comments
 (0)