Skip to content

Commit a7d878c

Browse files
committed
edit docs; etc.
1 parent 55ad9de commit a7d878c

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

CBOR/PeterO/Cbor/CBOREncodeOptions.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ public CBOREncodeOptions(
5555
this.ResolveReferences = false;
5656
this.AllowEmpty = false;
5757
this.Float64 = false;
58+
this.KeepKeyOrder = false;
5859
this.UseIndefLengthStrings = useIndefLengthStrings;
5960
this.AllowDuplicateKeys = allowDuplicateKeys;
6061
this.Ctap2Canonical = ctap2Canonical;
@@ -209,7 +210,9 @@ public bool UseIndefLengthStrings {
209210

210211
/// <summary>Gets a value indicating whether to preserve the order in
211212
/// which a CBOR map's keys appear when decoding a CBOR object, by
212-
/// using maps created as though by CBORObject.NewOrderedMap.</summary>
213+
/// using maps created as though by CBORObject.NewOrderedMap. If false,
214+
/// key order is not guaranteed to be preserved when decoding
215+
/// CBOR.</summary>
213216
/// <value>A value indicating whether to preserve the order in which a
214217
/// CBOR map's keys appear when decoding a CBOR object. The default is
215218
/// false.</value>

CBOR/PeterO/Cbor/JSONOptions.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,8 @@ public bool WriteBasic {
319319

320320
/// <summary>Gets a value indicating whether to preserve the order in
321321
/// which a map's keys appear when decoding JSON, by using maps created
322-
/// as though by CBORObject.NewOrderedMap.</summary>
322+
/// as though by CBORObject.NewOrderedMap. If false, key order is not
323+
/// guaranteed to be preserved when decoding JSON.</summary>
323324
/// <value>A value indicating whether to preserve the order in which a
324325
/// CBOR map's keys appear when decoding JSON. The default is
325326
/// false.</value>

0 commit comments

Comments
 (0)