encode/django-rest-framework
1
1
Fork 0
mirror of https://github.com/encode/django-rest-framework.git synced 2025-08-04 12:30:11 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update FloatField signature docs

Browse Source
This commit is contained in:
Carlton Gibson 2017-10-04 13:23:35 +02:00 committed by GitHub
parent 8890539545
commit 5dd01c6f90
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api-guide/fields.md
View File

@ -250,9 +250,9 @@ A floating point representation.
Corresponds to `django.db.models.fields.FloatField`.
**Signature**: `FloatField(coerce_to_string=None, max_value=None, min_value=None, localize=False)`
**Signature**: `FloatField(coerce_to_string=False, max_value=None, min_value=None, localize=False)`
- `coerce_to_string` Set to `True` if string values should be returned for the representation, or `False` if `float` objects should be returned. Defaults to `False`. Note that setting `localize` will force the value to `True`.
- `coerce_to_string` Set to `True` if string values should be returned for the representation, or `False` if `float` objects should be returned. Defaults to `False`.
- `max_value` Validate that the number provided is no greater than this value.
- `min_value` Validate that the number provided is no less than this value.
- `localize` Set to `True` to enable localization of input and output based on the current locale. This will also force `coerce_to_string` to `True`. Defaults to `False`. Note that data formatting is enabled if you have set `USE_L10N=True` in your settings file.