Skip to content

Commit

Permalink
docs: fix a broken link and typos (#855)
Browse files Browse the repository at this point in the history
## Change Summary

Please summarise the changes this pull request is making here.

## Checklist

- [ ] Unit tests for the changes exist
- [ ] Tests pass without significant drop in coverage
- [ ] Documentation reflects changes where applicable
- [ ] Test snapshots have been
[updated](https://prisma-client-py.readthedocs.io/en/latest/contributing/contributing/#snapshot-tests)
if applicable

## Agreement

By submitting this pull request, I confirm that you can use, modify,
copy and redistribute this contribution, under the terms of your choice.
  • Loading branch information
Oreoxmt committed Dec 12, 2023
1 parent 21b58f6 commit feaef23
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/getting_started/quickstart.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Quickstart

!!! note
Adapted from the Prisma Client Go [documentation](https://github.com/prisma/prisma-client-go/blob/master/docs/quickstart.md)
Adapted from the [Prisma Client Go documentation](https://goprisma.org/docs/getting-started/quickstart)

In this page, you will learn how to send queries to an SQLite database using Prisma Client Python and
run static type checks.

## Setup

1) Setup a Python project with a [virtual environment](https://docs.python.org/3/library/venv.html)
1) Set up a Python project with a [virtual environment](https://docs.python.org/3/library/venv.html)

```sh
mkdir demo && cd demo
Expand Down Expand Up @@ -57,15 +57,15 @@ prisma db push
If you make changes to your prisma schema, you need to run this command again.

!!! note
The `db push` command also generates the client for you, if you want to generate the client without
modifying your database, use the following command
The `db push` command also generates the client for you. If you want to generate the client without
modifying your database, use the following command:

```sh
prisma generate
```

!!! hint
you can add the `--watch` flag to re-generate the client whenever you modify the `schema.prisma` file
You can add the `--watch` flag to re-generate the client whenever you modify the `schema.prisma` file:
```sh
prisma generate --watch
```
Expand Down Expand Up @@ -108,7 +108,7 @@ found post: {
### Setup

!!! note
I am the maintainer of the [pyright PyPI package](https://pypi.org/project/pyright/) which is a wrapper over the [official version](https://github.com/microsoft/pyright) which is maintained by microsoft
I am the maintainer of the [pyright PyPI package](https://pypi.org/project/pyright/) which is a wrapper over the [official version](https://github.com/microsoft/pyright) which is maintained by Microsoft.

1) Install pyright

Expand Down Expand Up @@ -140,7 +140,7 @@ Completed in 1.322sec

### Error reporting

For example, add the following line to the end of the main() function
For example, add the following line to the end of the `main()` function

```py
async def main() -> None:
Expand Down

0 comments on commit feaef23

Please sign in to comment.