Skip to content

Commit

Permalink
Fix a few typos in documentation (#689)
Browse files Browse the repository at this point in the history
* Fix typo in example code

* Fix more typos
  • Loading branch information
danielhoherd authored Nov 9, 2023
1 parent 7457e68 commit cf1de4f
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.

<b>
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.
</b>


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<b>
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.
</b>


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs_src/src/pages/documentation/example_app/templates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit cf1de4f

Please sign in to comment.