From 5d2e92fafe7b1d887c3972bb07726cdf972f2ace Mon Sep 17 00:00:00 2001 From: Radoslav Georgiev Date: Tue, 26 Jul 2016 18:22:25 +0300 Subject: [PATCH] Change signature of `DateTimeField` and add detail to `format` - Signature is saying `format=None` while it is `format=empty`. This can lead to confusion, thinking the default behavior of the field is with `format=None` --- docs/api-guide/fields.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md index f95608afb..576e4e92e 100644 --- a/docs/api-guide/fields.md +++ b/docs/api-guide/fields.md @@ -290,9 +290,9 @@ A date and time representation. Corresponds to `django.db.models.fields.DateTimeField`. -**Signature:** `DateTimeField(format=None, input_formats=None)` +**Signature:** `DateTimeField(format=empty, input_formats=None)` -* `format` - A string representing the output format. If not specified, this defaults to the same value as the `DATETIME_FORMAT` settings key, which will be `'iso-8601'` unless set. Setting to a format string indicates that `to_representation` return values should be coerced to string output. Format strings are described below. Setting this value to `None` indicates that Python `datetime` objects should be returned by `to_representation`. In this case the datetime encoding will be determined by the renderer. +* `format` - A string representing the output format. If not specified, this defaults to the same value as the `DATETIME_FORMAT` settings key, which will be `'iso-8601'` unless set. Setting to a format string indicates that `to_representation` return values should be coerced to string output. Format strings are described below. Setting this value to `None` indicates that Python `datetime` objects should be returned by `to_representation`. In this case the datetime encoding will be determined by the renderer. The default value is [`empty`](https://github.com/tomchristie/django-rest-framework/blob/master/rest_framework/fields.py#L42), not `None`. You need to explicitly set `format=None` in order to get Python `datetime` object. * `input_formats` - A list of strings representing the input formats which may be used to parse the date. If not specified, the `DATETIME_INPUT_FORMATS` setting will be used, which defaults to `['iso-8601']`. #### `DateTimeField` format strings.