aboutsummaryrefslogtreecommitdiffstats
path: root/docs/api-guide
diff options
context:
space:
mode:
authorStephan Groß2013-03-01 15:03:27 +0100
committerStephan Groß2013-03-01 16:50:18 +0100
commita9d36d4726fc8eea02184b089ee6ed1d02e4c75e (patch)
tree73ae57b9cdf53153a05c84a0a96f043c8db9b073 /docs/api-guide
parentf208d8d2bbe2f418caa51199070f703fba544d49 (diff)
downloaddjango-rest-framework-a9d36d4726fc8eea02184b089ee6ed1d02e4c75e.tar.bz2
Add docs update - part 1
Diffstat (limited to 'docs/api-guide')
-rw-r--r--docs/api-guide/fields.md24
-rw-r--r--docs/api-guide/settings.md35
2 files changed, 53 insertions, 6 deletions
diff --git a/docs/api-guide/fields.md b/docs/api-guide/fields.md
index abacc1b8..c1f3c051 100644
--- a/docs/api-guide/fields.md
+++ b/docs/api-guide/fields.md
@@ -185,18 +185,20 @@ Corresponds to `django.forms.fields.RegexField`
A date representation.
-Uses `DATE_INPUT_FORMATS` to validate date.
-
Optionally takes `format` as parameter to replace the matching pattern.
Corresponds to `django.db.models.fields.DateField`
+**Signature:** `DateField(input_formats=None, output_format=False)`
+
+ - `input_formats` designates which input formats are supported. This will override the `DATE_INPUT_FORMATS`
+
+ - `output_format` designates which output format will be used. This will override the `DATE_OUTPUT_FORMAT`
+
## DateTimeField
A date and time representation.
-Uses `DATETIME_INPUT_FORMATS` to validate date_time.
-
Optionally takes `format` as parameter to replace the matching pattern.
Corresponds to `django.db.models.fields.DateTimeField`
@@ -211,16 +213,26 @@ If you want to override this behavior, you'll need to declare the `DateTimeField
class Meta:
model = Comment
+**Signature:** `DateTimeField(input_formats=None, output_format=False)`
+
+ - `input_formats` designates which input formats are supported. This will override the `DATETIME_INPUT_FORMATS`
+
+ - `output_format` designates which output format will be used. This will override the `DATETIME_OUTPUT_FORMAT`
+
## TimeField
A time representation.
-Uses `TIME_INPUT_FORMATS` to validate time.
-
Optionally takes `format` as parameter to replace the matching pattern.
Corresponds to `django.db.models.fields.TimeField`
+**Signature:** `TimeField(input_formats=None, output_format=False)`
+
+ - `input_formats` designates which input formats are supported. This will override the `TIME_INPUT_FORMATS`
+
+ - `output_format` designates which output format will be used. This will override the `TIME_OUTPUT_FORMAT`
+
## IntegerField
An integer representation.
diff --git a/docs/api-guide/settings.md b/docs/api-guide/settings.md
index e103fbab..9080cacb 100644
--- a/docs/api-guide/settings.md
+++ b/docs/api-guide/settings.md
@@ -174,4 +174,39 @@ The name of a parameter in the URL conf that may be used to provide a format suf
Default: `'format'`
+## DATE_INPUT_FORMATS
+
+Default:
+
+ (
+ '%Y-%m-%d', # '1984-07-31'
+ )
+
+## DATE_OUTPUT_FORMAT
+
+## DATETIME_INPUT_FORMATS
+
+Default:
+
+ (
+ '%Y-%m-%d', # '1984-07-31'
+ '%Y-%m-%d %H:%M', # '1984-07-31 04:31'
+ '%Y-%m-%d %H:%M:%S', # '1984-07-31 04:31:59'
+ '%Y-%m-%d %H:%M:%S.%f', # '1984-07-31 04:31:59.000200'
+ )
+
+## DATETIME_OUTPUT_FORMAT
+
+## TIME_INPUT_FORMATS
+
+Default:
+
+ (
+ '%H:%M', # '04:31'
+ '%H:%M:%S', # '04:31:59'
+ '%H:%M:%S.%f', # '04:31:59.000200'
+ )
+
+## TIME_OUTPUT_FORMAT
+
[cite]: http://www.python.org/dev/peps/pep-0020/