Merge pull request #69 from numberoverzero/dev

Update docs so UserSchema _links point to correct routes
marshmallow-code · Dec 8, 2017 · 7208b90 · 7208b90
2 parents 58583e5 + 9dbbabe
commit 7208b90
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 9 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -1,14 +1,19 @@
 Changelog
 =========
 
+Unreleased
+**********
+
+* Updated documentation to fix example ``ma.URLFor`` target.
+
 0.8.0 (2017-05-28)
 ******************
 
 * Fix compatibility with marshmallow>=3.0.
 
 Support:
 
-* *Backwards-incompatible*: Drop support for marshmallow<=2.0.0. 
+* *Backwards-incompatible*: Drop support for marshmallow<=2.0.0.
 * Test against Python 3.6.
 
 0.7.0 (2016-06-28)

diff --git a/README.rst b/README.rst
@@ -49,8 +49,8 @@ Define your output format with marshmallow.
             fields = ('email', 'date_created', '_links')
         # Smart hyperlinking
         _links = ma.Hyperlinks({
-            'self': ma.URLFor('author_detail', id='<id>'),
-            'collection': ma.URLFor('authors')
+            'self': ma.URLFor('user_detail', id='<id>'),
+            'collection': ma.URLFor('users')
         })
 
     user_schema = UserSchema()
@@ -77,8 +77,8 @@ Output the data in your views.
     #     "email": "fred@queen.com",
     #     "date_created": "Fri, 25 Apr 2014 06:02:56 -0000",
     #     "_links": {
-    #         "self": "/api/authors/42",
-    #         "collection": "/api/authors/"
+    #         "self": "/api/users/42",
+    #         "collection": "/api/users/"
     #     }
     # }
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -53,8 +53,8 @@ Define your output format with marshmallow.
             fields = ('email', 'date_created', '_links')
         # Smart hyperlinking
         _links = ma.Hyperlinks({
-            'self': ma.URLFor('author_detail', id='<id>'),
-            'collection': ma.URLFor('authors')
+            'self': ma.URLFor('user_detail', id='<id>'),
+            'collection': ma.URLFor('users')
         })
 
     user_schema = UserSchema()
@@ -81,8 +81,8 @@ Output the data in your views.
     #     "email": "fred@queen.com",
     #     "date_created": "Fri, 25 Apr 2014 06:02:56 -0000",
     #     "_links": {
-    #         "self": "/api/authors/42",
-    #         "collection": "/api/authors/"
+    #         "self": "/api/users/42",
+    #         "collection": "/api/users/"
     #     }
     # }