documented new summary serializer via docstrings

Author: calumbell

api_v2/serializers/ability.py

@@ -23,6 +23,11 @@ class Meta:
         fields = '__all__'
 
 class AbilitySummarySerializer(GameContentSerializer):
+    '''
+    A slimmer AbilitySerializer, designed to serialize Ability FKs on other 
+    serializers. ie. The `saving_throws` field on CharacterClassSerializer. Not
+    intended to be used directly with in a ModelViewset.
+    '''
     class Meta:
         model = models.Ability
         fields = ['name', 'url']

api_v2/serializers/characterclass.py

@@ -70,6 +70,12 @@ class Meta:
         ]
 
 class CharacterClassSummarySerializer(serializers.ModelSerializer):
+    '''
+    A slimmer CharacterClassSerializer, designed to serialize Class FKs on
+    other serializers. ie. The `subclass_of` field on the 
+    CharacterClassSerializer serializer. Not intended to be used directly in a
+    ModelViewset.
+    '''
     class Meta:
         model = models.CharacterClass
         fields = ['name', 'key', 'url']

api_v2/serializers/condition.py

@@ -18,6 +18,11 @@ class Meta:
         fields = '__all__'
 
 class ConditionSummarySerializer(GameContentSerializer):
+    '''
+    A slimmer ConditionSerializer, designed to serialize Condition FKs on
+    other serializers. ie. The `condition_immunities` field on the Creature
+    serializer. Not intended to be used directly with in a ModelViewset.
+    '''
     class Meta:
         model = models.Condition
         fields = ['name', 'key', 'url']

api_v2/serializers/creature.py

@@ -48,6 +48,10 @@ class Meta:
         fields = '__all__'
 
 class CreatureTypeSummarySerializer(serializers.ModelSerializer):
+    '''
+    A slimmer CreatureTypeSerializer, designed to serialize CreatureType FKs on
+    other serializers . Not intended to be used directly with in a ModelViewset.
+    '''
     class Meta:
         model = models.CreatureType
         fields = ['name', 'key', 'url']

api_v2/serializers/damagetype.py

@@ -14,6 +14,10 @@ class Meta:
         fields = '__all__'
 
 class DamageTypeSummarySerializer(serializers.ModelSerializer):
+    '''
+    A slimmer DamageTypeSerializer, designed to serialize DamageType FKs on
+    other serializers. Not intended to be used directly with in a ModelViewset.
+    '''
     class Meta:
         model = models.DamageType
         fields = ['name', 'key', 'url']

api_v2/serializers/document.py

@@ -12,6 +12,10 @@ class Meta:
         fields = '__all__'
 
 class GameSystemSummarySerializer(serializers.ModelSerializer):
+    '''
+    A slimmer GameSystemSerializer, designed to serialize GameSystem FKs on 
+    other serializers. Not intended to be used directly with in a ModelViewset.
+    '''
     class Meta:
         model = models.GameSystem
         fields = ['name', 'key', 'url']
@@ -25,7 +29,10 @@ class Meta:
         fields = '__all__'
 
 class LicenseSummarySerializer(GameContentSerializer):
-    key = serializers.ReadOnlyField()
+    '''
+    A slimmer LicenseSerializer, designed to serialize License FKs on other 
+    serializers. Not intended to be used directly with in a ModelViewset.
+    '''
     class Meta:
         model = models.License
         fields = ['name', 'key', 'url']
@@ -38,7 +45,10 @@ class Meta:
         fields = '__all__'
 
 class PublisherSummarySerializer(serializers.ModelSerializer):
-    key = serializers.ReadOnlyField()
+    '''
+    A slimmer PublisherSerializer, designed to serialize Publisher FKs on other
+    serializers. Not intended to be used directly with in a ModelViewset.
+    '''
     class Meta:
         model = models.Publisher
         fields = ['name', 'key', 'url']
@@ -54,9 +64,13 @@ class Meta:
         fields = '__all__'
 
 class DocumentSummarySerializer(GameContentSerializer):
-    key = serializers.ReadOnlyField()
+    '''
+    A slimmer DocumentSerializer, designed to serialize Documents FKs on other
+    serializers. Not intended to be used directly with in a ModelViewset.
+    '''
     publisher = PublisherSummarySerializer()
     gamesystem = GameSystemSummarySerializer()
+
     class Meta:
         model = models.Document
         fields = ['name', 'key', 'publisher', 'gamesystem', 'permalink']

api_v2/serializers/environment.py

@@ -14,6 +14,11 @@ class Meta:
         fields = '__all__'
 
 class EnvironmentSummarySerializer(GameContentSerializer):
+    '''
+    A slimmer EnvironmentSerializer, designed to serialize Enviroment FKs on
+    other serializers. ie. The `environments` field on the CreatureSerializer.
+    Not intended to be used directly in a ModelViewset.
+    '''
     class Meta:
         model = models.Environment
         fields = ['name', 'key', 'url']

api_v2/serializers/item.py

@@ -22,6 +22,11 @@ class Meta:
         fields = '__all__'
 
 class ArmorSummarySerializer(serializers.ModelSerializer):
+    '''
+    A slightly slimmer ArmorSerializer, designed to serialize Armor FKs on
+    other serializers. ie. The `armor` field on the ItemSerializer. Not 
+    intended to be used directly in a ModelViewset.
+    '''
     class Meta:
         model = models.Armor
         fields = [

api_v2/serializers/size.py

@@ -25,6 +25,11 @@ def get_distance_unit(self, Size):
         return Size.get_distance_unit
 
 class SizeSummarySerializer(serializers.ModelSerializer):
+    '''
+    A slimmer SizeSerializer, designed to serialize Size FKs on other
+    serializers. ie. The `size` field on the CreatureSerializer. Not intended
+    to be used directly in a ModelViewset.
+    '''
     class Meta:
         model = models.Size
         fields = ['name', 'key', 'url']

api_v2/serializers/spell.py

@@ -17,6 +17,11 @@ class Meta:
         fields='__all__'
 
 class SpellSchoolSummarySerializer(serializers.ModelSerializer):
+    '''
+    A slimmer SpellSchoolSerializer, designed to serialize Spell School FKs on 
+    other serializers. ie. The `school` field on the SpellSerializer. Not
+    intended to be used directly in a ModelViewset.
+    '''
     class Meta:
         model = models.SpellSchool
         fields = ['name', 'key', 'url']