aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTom Christie2014-12-05 13:07:48 +0000
committerTom Christie2014-12-05 13:07:48 +0000
commit78f5bcb5cbc9cbed6c335734e81714bc2daa294a (patch)
tree87f9d93a938c47e7cfa4b8c60a1c9f4ec75fcc6b
parent6cce0681a9da20f46f57aa2c19796b4266c3d505 (diff)
downloaddjango-rest-framework-78f5bcb5cbc9cbed6c335734e81714bc2daa294a.tar.bz2
Update documentation
-rw-r--r--api-guide/serializers/index.html8
-rw-r--r--tutorial/1-serialization/index.html22
2 files changed, 12 insertions, 18 deletions
diff --git a/api-guide/serializers/index.html b/api-guide/serializers/index.html
index 75c3f454..08a68bb0 100644
--- a/api-guide/serializers/index.html
+++ b/api-guide/serializers/index.html
@@ -807,9 +807,9 @@ serializer.errors
# would need to be handled.
profile = instance.profile
- user.username = validated_data.get('username', instance.username)
- user.email = validated_data.get('email', instance.email)
- user.save()
+ instance.username = validated_data.get('username', instance.username)
+ instance.email = validated_data.get('email', instance.email)
+ instance.save()
profile.is_premium_member = profile_data.get(
'is_premium_member',
@@ -821,7 +821,7 @@ serializer.errors
)
profile.save()
- return user
+ return instance
</code></pre>
<p>Because the behavior of nested creates and updates can be ambiguous, and may require complex dependancies between related models, REST framework 3 requires you to always write these methods explicitly. The default <code>ModelSerializer</code> <code>.create()</code> and <code>.update()</code> methods do not include support for writable nested representations.</p>
<p>It is possible that a third party package, providing automatic support some kinds of automatic writable nested representations may be released alongside the 3.1 release.</p>
diff --git a/tutorial/1-serialization/index.html b/tutorial/1-serialization/index.html
index 9b5ffb35..292b1099 100644
--- a/tutorial/1-serialization/index.html
+++ b/tutorial/1-serialization/index.html
@@ -411,8 +411,7 @@
<hr />
<h2 id="setting-up-a-new-environment">Setting up a new environment</h2>
<p>Before we do anything else we'll create a new virtual environment, using <a href="http://www.virtualenv.org/en/latest/index.html">virtualenv</a>. This will make sure our package configuration is kept nicely isolated from any other projects we're working on.</p>
-<pre><code>:::bash
-virtualenv env
+<pre><code>virtualenv env
source env/bin/activate
</code></pre>
<p>Now that we're inside a virtualenv environment, we can install our package requirements.</p>
@@ -460,12 +459,8 @@ class Snippet(models.Model):
title = models.CharField(max_length=100, blank=True, default='')
code = models.TextField()
linenos = models.BooleanField(default=False)
- language = models.CharField(choices=LANGUAGE_CHOICES,
- default='python',
- max_length=100)
- style = models.CharField(choices=STYLE_CHOICES,
- default='friendly',
- max_length=100)
+ language = models.CharField(choices=LANGUAGE_CHOICES, default='python', max_length=100)
+ style = models.CharField(choices=STYLE_CHOICES, default='friendly', max_length=100)
class Meta:
ordering = ('created',)
@@ -483,14 +478,11 @@ from snippets.models import Snippet, LANGUAGE_CHOICES, STYLE_CHOICES
class SnippetSerializer(serializers.Serializer):
pk = serializers.IntegerField(read_only=True)
- title = serializers.CharField(required=False, allow_blank=True
- max_length=100)
+ title = serializers.CharField(required=False, allow_blank=True, max_length=100)
code = serializers.CharField(style={'type': 'textarea'})
linenos = serializers.BooleanField(required=False)
- language = serializers.ChoiceField(choices=LANGUAGE_CHOICES,
- default='python')
- style = serializers.ChoiceField(choices=STYLE_CHOICES,
- default='friendly')
+ language = serializers.ChoiceField(choices=LANGUAGE_CHOICES, default='python')
+ style = serializers.ChoiceField(choices=STYLE_CHOICES, default='friendly')
def create(self, validated_data):
"""
@@ -552,6 +544,8 @@ data = JSONParser().parse(stream)
<pre><code>serializer = SnippetSerializer(data=data)
serializer.is_valid()
# True
+serializer.validated_data
+# OrderedDict([('title', ''), ('code', 'print "hello, world"\n'), ('linenos', False), ('language', 'python'), ('style', 'friendly')])
serializer.save()
# &lt;Snippet: Snippet object&gt;
</code></pre>