1
1
mirror of https://github.com/encode/django-rest-framework.git synced 2025-08-20 12:14:48 +03:00
Commit Graph

186 Commits

Author SHA1 Message Date
Peter Thomassen
7900778fbe
Remove obsolete sentence from docs 2024-04-30 18:24:23 +02:00
Mathieu Dupuy
c9e7b68a4c
minor documentation improvements and fixes ()
* minor documentation improvements and fixes

* Update docs/api-guide/fields.md

---------

Co-authored-by: Tom Christie <tom@tomchristie.com>
2023-03-14 13:31:34 +00:00
Özgür
34953774f3
docs: fix code example () 2023-02-16 12:48:34 +06:00
Francisco Couzo
041b88f8bb
Improve style, fix some typos ()
* Improve style, fix some typos

* Update docs/api-guide/fields.md

Co-authored-by: Tom Christie <tom@tomchristie.com>

Co-authored-by: Tom Christie <tom@tomchristie.com>
2022-10-19 11:20:11 +01:00
Shyamkumar Yadav
20d347a806
Docs: Convert all tabs into spaces () 2022-10-12 11:23:45 +01:00
Aaron Taajik
5b616c503f
docs: fix level of some headings () 2022-09-05 13:02:12 +01:00
Aaron Taajik
1ca1583513
docs: add the missing module name () 2022-09-05 11:20:23 +01:00
Guilouf
45082b3936
Fixed missing "fields" meta argument in docs ()
* Fixed missing "fields" meta argument in docs, leading to an assertion error

* Update docs/api-guide/serializers.md

Co-authored-by: Tom Christie <tom@tomchristie.com>

Co-authored-by: Tom Christie <tom@tomchristie.com>
2021-12-17 15:20:14 +00:00
Yecine Megdiche
380ac8e79d
Remove old-style super calls () 2021-12-06 15:32:33 +00:00
Akhil Kokani
1fa5bc31c0
Update serializers.md ()
* Update serializers.md

Removed unwanted word, "neither".

* Update docs/api-guide/serializers.md

Co-authored-by: Tom Christie <tom@tomchristie.com>
2021-09-27 10:01:47 +01:00
Dan Lousqui
f0a5b958a1
Add max_length and min_length options to ListSerializer () 2021-09-14 13:45:55 +01:00
Nikita Sobolev
d2977cff98
Fixes inconsistent headers in serializer docs ()
Some headers were using `.`, some - were not.
Now, all of them are the same with `.`, because it was easier to fix.
2021-06-28 13:07:41 +01:00
Erwin Junge
bb133522ef Small documentation fix 2020-11-22 12:21:30 +01:00
Adam Johnson
fd5e1a745a
Fixed some documentation headings to use a space () 2020-10-10 17:42:59 +01:00
Thomas Riccardi
1ef192811c
Add missing quoting for data keyword argument in serializer doc () 2020-10-10 17:34:39 +01:00
Masked Man
17f2b39bdb
Fix docs issue () 2020-08-05 15:33:30 -07:00
Oğuzhan Çelikarslan
36bd1b30d8
drf-encrypt-content added into third party list in documentation's serializer page () 2020-07-06 11:56:46 +01:00
Nikhil Kumar
505a69cf43
Fixed heading markdown 2020-06-01 13:49:43 -04:00
johnthagen
fccfdd21c0
Remove object inheritance in docs () 2020-05-13 17:54:46 -07:00
0dysseas
be96939ec1
Fix serializer example in docs () 2020-03-17 09:49:19 -07:00
Samuel Dion-Girardeau
e32ffbb12b
Fix docs code example () 2020-02-24 16:33:00 -08:00
Prayash Mohapatra
764dabd29e
Update writeable nested serializer doc () 2020-02-20 10:55:13 +00:00
Braden MacDonald
3aa1089a6a Update serializer docs to use correct param name ()
Avoids a pylint warning ".to_representation: Parameters differ from overridden 'to_representation' method" if people copy these examples.
2019-10-15 15:47:05 +01:00
Law Karingithi
0e4811e9ce Fix minor grammatical errors in docs () 2019-10-08 09:38:14 -07:00
linchiwei123
da1c6d4129 Fix indent () 2019-07-18 23:09:04 -07:00
Luke Plant
f0dbf0a264 Update docs to use lists instead of tuples () 2019-07-12 18:15:36 -07:00
Tom Christie
cc88c8a6f3
Update serializers.md 2019-07-08 11:12:30 +01:00
linchiwei123
8fbf8c3fa3 Update serializers.md () 2019-07-05 09:11:20 +01:00
Ryan P Kilby
82c2b5c3e7
Update mkdocs () 2019-06-30 19:04:36 -07:00
David Sanders
95e28b2252
Fix typo in docs 2019-04-27 12:07:49 -07:00
Dmitry Alimov
1ac0f63aa9 Fix private attributes ignore in documentation () 2019-04-21 17:27:13 +01:00
Billy Rotich
f8c4e5079e Minor documentation fixes () 2019-04-13 15:02:19 +02:00
Michael Käufl
f9401f5ff0
Fix Python 3 compat in documentation 2019-02-16 15:47:13 +01:00
Mice Pápai
d0369b27cd update docs/api-guide/serializers.md: consistency () 2018-11-15 14:44:54 +00:00
Jon Dufresne
4d57d46bf8 Prefer io.BytesIO over six; available on all supported Pythons ()
On all supported Pythons, the io.BytesIO is always a stream
implementation using an in-memory bytes buffer.

Makes code slightly more forward compatible by reducing use of the six
module and promotes more forward compatible practices in the docs.
2018-09-09 11:53:41 +01:00
David Sanders
69f605f30e
Fix validate_my_field signature 2018-09-06 18:16:06 -07:00
Steven Loria
8a639c6c06 Update link to django-rest-marshmallow docs () 2018-04-09 16:48:18 +02:00
Teddy Cross
78367ba102 Always fully qualify ValidationError in docs () 2018-01-19 08:40:09 +01:00
Jon Dufresne
d3f3c3d9c1 Prefer https protocol for links in docs when available 2018-01-15 15:15:21 +01:00
Jon Dufresne
ffe3dbb1b1 Perfer iter(dict) over iter(dict.keys()) ()
Calling dict.keys() is unnecessary. The two are functionally equivalent
on modern Pythons.

Inspired by Lennart Regebro's talk "Prehistoric Patterns in Python" from
PyCon 2017.

https://www.youtube.com/watch?v=V5-JH23Vk0I
2018-01-08 09:49:46 +00:00
Mariano Baragiola
be0a57b0f1 FIX link 2017-12-27 10:28:59 -03:00
Mariano Baragiola
6ce60cd594 Update writable nested serializers docs 2017-12-27 10:17:10 -03:00
Carlton Gibson
b3a0b271cd
Add example to to_representation docs ()
Closes  as per https://github.com/encode/django-rest-framework/issues/5425#issuecomment-341063819
2017-12-19 12:06:24 +01:00
Hang Park
01587b9eb1 Typos in serializers documentation ()
Fixes .

Change `update()` to `.update()` in serializers documentation to get a
consistency with `.create()`.
2017-12-04 07:00:03 -05:00
bartkim0426
9c11077cf6 Fix in documentation ()
- typo in serialization document: 'intead' => 'instead'
2017-11-20 09:08:16 +01:00
Alexei Znamensky
20954469b2 Fix in documentation ()
- model serializers now must provide either "fields" or "exclude" as attribute
2017-11-20 09:07:36 +01:00
Xavier Ordoquy
f585eee125 Remove duplicated line 2017-10-09 22:19:53 +02:00
Ryan P Kilby
e0a6c4b5bd Clarify 'to_internal_value()' validation behavior () 2017-10-02 13:51:48 +01:00
Vadim Laletin
c0475d059d Update link to drf-writable-nested repository in third-party serializers 2017-08-29 10:39:52 +07:00
Vadim
d390762e18 Add drf-writable-nested package to third-party serializers () 2017-02-20 15:16:27 +00:00