From cf1de4f7d64390e4a4bbe3b1d8373961a3d01844 Mon Sep 17 00:00:00 2001 From: Daniel Hoherd Date: Thu, 9 Nov 2023 04:24:14 -0500 Subject: [PATCH] Fix a few typos in documentation (#689) * Fix typo in example code * Fix more typos --- .../src/pages/documentation/api_reference/authentication.mdx | 4 ++-- .../src/pages/documentation/api_reference/const_requests.mdx | 2 +- docs_src/src/pages/documentation/api_reference/robyn_env.mdx | 2 +- .../src/pages/documentation/example_app/modeling_routes.mdx | 2 +- docs_src/src/pages/documentation/example_app/templates.mdx | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs_src/src/pages/documentation/api_reference/authentication.mdx b/docs_src/src/pages/documentation/api_reference/authentication.mdx index ed8c5502c..32ef61603 100644 --- a/docs_src/src/pages/documentation/api_reference/authentication.mdx +++ b/docs_src/src/pages/documentation/api_reference/authentication.mdx @@ -5,7 +5,7 @@ export const description = After Creating a basic version of the app, Batman wanted to restrict the access to the Gotham Police Department. So, he enquired about the Authentication functionalities in Robyn. -## Authenticaion +## Authentication As Batman found out, Robyn provides an easy way to add an authentication middleware to your application. You can then specify `auth_required=True` in your routes to make them accessible only to authenticated users. @@ -77,7 +77,7 @@ As Batman found out, Robyn provides an easy way to add an authentication middlew The authenticate method should return an `Identity` object if the user is authenticated, or `None` otherwise. The Identity object can contain any data you want, and will be accessible in the route methods using the `request.identity` attribute. - Note: that this authentication system is basically only using a `before request` middleware under the hood. This means you can overlook it and create your own authentication system using middlewares if you want to. However, Robyn still provide this easy to implement solution that should suit most use cases. + Note: that this authentication system is basically only using a `before request` middleware under the hood. This means you can overlook it and create your own authentication system using middlewares if you want to. However, Robyn still provides this easy to implement solution that should suit most use cases. diff --git a/docs_src/src/pages/documentation/api_reference/const_requests.mdx b/docs_src/src/pages/documentation/api_reference/const_requests.mdx index 45d34eb84..25e7c09fd 100644 --- a/docs_src/src/pages/documentation/api_reference/const_requests.mdx +++ b/docs_src/src/pages/documentation/api_reference/const_requests.mdx @@ -60,7 +60,7 @@ Robyn told Batman that he can use the `--workers` flag to scale the application The authenticate method should return an `Identity` object if the user is authenticated, or `None` otherwise. The Identity object can contain any data you want, and will be accessible in the route methods using the `request.identity` attribute. - Note: that this authentication system is basically only using a `before request` middleware under the hood. This means you can overlook it and create your own authentication system using middlewares if you want to. However, Robyn still provide this easy to implement solution that should suit most use cases. + Note: that this authentication system is basically only using a `before request` middleware under the hood. This means you can overlook it and create your own authentication system using middlewares if you want to. However, Robyn still provides this easy to implement solution that should suit most use cases. diff --git a/docs_src/src/pages/documentation/api_reference/robyn_env.mdx b/docs_src/src/pages/documentation/api_reference/robyn_env.mdx index 41fad274d..239d322df 100644 --- a/docs_src/src/pages/documentation/api_reference/robyn_env.mdx +++ b/docs_src/src/pages/documentation/api_reference/robyn_env.mdx @@ -3,7 +3,7 @@ export const description = 'In this section, we will learn how to configure the ## Configuring the server through an environment file -Batman wanted to configure the server through an environment file. Changing code continously induced the risk of error. +Batman wanted to configure the server through an environment file. Changing code continuously induced the risk of error. There are some environment variables that Robyn looks out for. e.g. `ROBYN_HOST` and `ROBYN_PORT`. diff --git a/docs_src/src/pages/documentation/example_app/modeling_routes.mdx b/docs_src/src/pages/documentation/example_app/modeling_routes.mdx index 468b08c3d..3dad8ea89 100644 --- a/docs_src/src/pages/documentation/example_app/modeling_routes.mdx +++ b/docs_src/src/pages/documentation/example_app/modeling_routes.mdx @@ -88,7 +88,7 @@ Batman created various endpoints to manage crime data. These endpoints allowed t ```python {{ title: 'Setting up Routes' }} # __main__.py -from robn import Robyn +from robyn import Robyn from robyn.robyn import Request, Response from sqlalchemy.orm import Session diff --git a/docs_src/src/pages/documentation/example_app/templates.mdx b/docs_src/src/pages/documentation/example_app/templates.mdx index 3deb1bbb6..3ea73c791 100644 --- a/docs_src/src/pages/documentation/example_app/templates.mdx +++ b/docs_src/src/pages/documentation/example_app/templates.mdx @@ -10,7 +10,7 @@ This is when he was introduced to templates! Templates are a powerful feature of the Robyn framework that allow you to create dynamic web pages using HTML and Python. They are a great way to add a frontend to your application without having to learn a new language or framework. -Robyn supports Jinja2 templats by default but provides an easy way to add other templating engines as well. +Robyn supports Jinja2 templates by default but provides an easy way to add other templating engines as well. ### Creating a Template