Fix relationship_descriptor docs

rel_descriptor was renamed to relationship_descriptor
AlexAndBear · Jan 8, 2018 · ff0f02d · ff0f02d
1 parent e920f8d
commit ff0f02d
Showing 1 changed file with 7 additions and 5 deletions.
diff --git a/docs/models.rst b/docs/models.rst
@@ -49,25 +49,27 @@ Relationship's come in two flavors: to-one and to-many (or tranditional and
 LDS-flavored if you prefer those terms).  To one descriptors have the actions
 GET and SET::
 
-        @rel_descriptor(RelationshipActions.GET, 'significant_other')
+        from sqlalchemy_jsonapi import relationship_descriptor, RelationshipActions
+
+        @relationship_descriptor(RelationshipActions.GET, 'significant_other')
         def getter(self):
             # ...
 
-        @rel_descriptor(RelationshipActions.SET, 'significant_other')
+        @relationship_descriptor(RelationshipActions.SET, 'significant_other')
         def setter(self, value):
             # ...
 
 To-many have GET, APPEND, and DELETE::
 
-        @rel_descriptor(RelationshipActions.GET, 'angry_exes')
+        @relationship_descriptor(RelationshipActions.GET, 'angry_exes')
         def getter(self):
             # ...
 
-        @rel_descriptor(RelationshipActions.APPEND, 'angry_exes')
+        @relationship_descriptor(RelationshipActions.APPEND, 'angry_exes')
         def appender(self):
             # ...
 
-        @rel_descriptor(RelationshipActions.DELETE, 'angry_exes')
+        @relationship_descriptor(RelationshipActions.DELETE, 'angry_exes')
         def remover(self):
             # ...