mirror of
https://github.com/encode/django-rest-framework.git
synced 2025-01-24 00:04:16 +03:00
Docs tweaks
This commit is contained in:
parent
018d8b8dce
commit
70831ad0bb
|
@ -16,7 +16,7 @@
|
||||||
|
|
||||||
# Overview
|
# Overview
|
||||||
|
|
||||||
Django REST framework is a lightweight library that makes it easy to build Web APIs. It is designed as a modular and easy to customize architecture, based on Django's class based views.
|
Django REST framework is a powerful and flexible toolkit that makes it easy to build Web APIs.
|
||||||
|
|
||||||
Web APIs built using REST framework are fully self-describing and web browseable - a huge useability win for your developers. It also supports a wide range of media types, authentication and permission policies out of the box.
|
Web APIs built using REST framework are fully self-describing and web browseable - a huge useability win for your developers. It also supports a wide range of media types, authentication and permission policies out of the box.
|
||||||
|
|
||||||
|
|
|
@ -124,6 +124,14 @@ Usage of the old-style attributes continues to be supported, but will raise a `P
|
||||||
|
|
||||||
For most cases APIs using model fields will behave as previously, however if you are using a custom renderer, not provided by REST framework, then you may now need to add support for rendering `Decimal` instances to your renderer implmentation.
|
For most cases APIs using model fields will behave as previously, however if you are using a custom renderer, not provided by REST framework, then you may now need to add support for rendering `Decimal` instances to your renderer implmentation.
|
||||||
|
|
||||||
|
## View names and descriptions
|
||||||
|
|
||||||
|
The mechanics of how view names and descriptions are generated from the docstring and classname has been modified and cleaned up somewhat.
|
||||||
|
|
||||||
|
If you've been customizing this behavior, for example perhaps to use `rst` markup for the browseable API, then you'll need to take a look at the implementation to see what updates you need to make.
|
||||||
|
|
||||||
|
Note that the relevant methods have always been private APIs, and the docstrings called them out as intended to be deprecated.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Other notes
|
# Other notes
|
||||||
|
|
Loading…
Reference in New Issue
Block a user