Skip to content

Commit 43c7af0

Browse files
Carlton Gibsontomchristie
authored andcommitted
Adjust ListField & DictField signature docs (#5333)
Closes #5301
1 parent 3110635 commit 43c7af0

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/api-guide/fields.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -434,7 +434,7 @@ Requires either the `Pillow` package or `PIL` package. The `Pillow` package is
434434

435435
A field class that validates a list of objects.
436436

437-
**Signature**: `ListField(child, min_length=None, max_length=None)`
437+
**Signature**: `ListField(child=<A_FIELD_INSTANCE>, min_length=None, max_length=None)`
438438

439439
- `child` - A field instance that should be used for validating the objects in the list. If this argument is not provided then objects in the list will not be validated.
440440
- `min_length` - Validates that the list contains no fewer than this number of elements.
@@ -457,7 +457,7 @@ We can now reuse our custom `StringListField` class throughout our application,
457457

458458
A field class that validates a dictionary of objects. The keys in `DictField` are always assumed to be string values.
459459

460-
**Signature**: `DictField(child)`
460+
**Signature**: `DictField(child=<A_FIELD_INSTANCE>)`
461461

462462
- `child` - A field instance that should be used for validating the values in the dictionary. If this argument is not provided then values in the mapping will not be validated.
463463

0 commit comments

Comments
 (0)