fix small typo and change the contribution docs (#291)

* fix small typo and change the contribution docs

* fix tests with the latest Piccolo ORM changes

* remove accidentally left postgres password

Author: sinisaos

docs/source/contributing/index.rst

@@ -31,7 +31,8 @@ The docs are written using Sphinx. To get them running locally:
 * Install the requirements: ``pip install -r requirements/doc-requirements.txt``
 * ``cd docs``
 * Do an initial build of the docs: ``make html``
-* Serve the docs: ``scripts/run-docs.sh``
+* ``cd ..``
+* Serve the docs: ``./scripts/run-docs.sh``
 * The docs will auto rebuild as you make changes.
 
 -------------------------------------------------------------------------------

docs/source/register/endpoints.rst

@@ -32,7 +32,7 @@ Here's a Starlette example:
 
     app = Starlette()
 
-    app.mount('/register/', register(redirect_to="/login/"))
+    app.mount("/register/", register(redirect_to="/login/"))
 
 Here's a FastAPI example:
 
@@ -43,7 +43,7 @@ Here's a FastAPI example:
 
     app = FastAPI()
 
-    app.mount('/register/', register(redirect_to="/login/"))
+    app.mount("/register/", register(redirect_to="/login/"))
 
 Security
 ~~~~~~~~
@@ -70,7 +70,7 @@ Modifying the FastAPI example above:
     app = FastAPI()
 
     app.mount(
-        '/register/',
+        "/register/",
         RateLimitingMiddleware(
             register(redirect_to="/login/"),
             InMemoryLimitProvider(
@@ -104,24 +104,24 @@ following:
 
     # To use hCaptcha:
     app.mount(
-        '/register/',
+        "/register/",
         register(
             redirect_to="/login/",
             captcha=hcaptcha(
-                site_key='my-site-key',
-                secret_key='my-secret-key',
+                site_key="my-site-key",
+                secret_key="my-secret-key",
             )
         )
     )
 
     # To use reCAPTCHA:
     app.mount(
-        '/register/',
+        "/register/",
         register(
             redirect_to="/login/",
             captcha=recaptcha_v2(
-                site_key='my-site-key',
-                secret_key='my-secret-key',
+                site_key="my-site-key",
+                secret_key="my-secret-key",
             )
         )
     )

docs/source/session_auth/endpoints.rst

@@ -46,7 +46,7 @@ Here's a Starlette example:
 
     app = Starlette()
 
-    app.mount('/login/', session_login())
+    app.mount("/login/", session_login())
 
 Here's a FastAPI example:
 
@@ -57,7 +57,7 @@ Here's a FastAPI example:
 
     app = FastAPI()
 
-    app.mount('/login/', session_login())
+    app.mount("/login/", session_login())
 
 Source
 ~~~~~~
@@ -95,7 +95,7 @@ Here's a Starlette example:
 
     app = Starlette()
 
-    app.mount('/logout/', session_logout())
+    app.mount("/logout/", session_logout())
 
 Here's a FastAPI example:
 
@@ -106,7 +106,7 @@ Here's a FastAPI example:
 
     app = FastAPI()
 
-    app.mount('/login/', session_logout())
+    app.mount("/logout/", session_logout())
 
 
 Source

tests/crud/test_crud_endpoints.py

@@ -277,7 +277,9 @@ def test_patch_user_fails(self):
 
         response = client.patch(f"/{user['id']}/", json=json)
         self.assertEqual(response.status_code, 400)
-        self.assertEqual(response.content, b"The password is too short.")
+        self.assertEqual(
+            response.content, b"The password is too short. (min 6)"
+        )
 
     def test_patch_fails(self):
         """
@@ -1353,7 +1355,7 @@ def test_post_user_fails(self):
 
         response = client.post("/", json=json)
         self.assertEqual(
-            response.content, b"Error: The password is too short."
+            response.content, b"Error: The password is too short. (min 6)"
         )
         self.assertEqual(response.status_code, 400)