Skip to content

Commit

Permalink
docs: polishes & typos (#772)
Browse files Browse the repository at this point in the history
## Change Summary

This PR polishes docs a bit.

## 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
izeye authored Jun 16, 2023
1 parent 32dd88a commit 5713263
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ A prisma schema can define one or more generators, defined by the `generator` bl

A generator determines what assets are created when you run the `prisma generate` command. The `provider` value defines which Prisma Client will be created. In this case, as we want to generate Prisma Client Python, we use the `prisma-client-py` value.

You can also define where the client will be generated to with the `output` option. By default Prisma Client Python will be generated to the same location it was installed to, whether thats inside a virtual environment, the global python installation or anywhere else that python packages can be imported from.
You can also define where the client will be generated to with the `output` option. By default Prisma Client Python will be generated to the same location it was installed to, whether that's inside a virtual environment, the global python installation or anywhere else that python packages can be imported from.

For more options see [configuring Prisma Client Python](https://prisma-client-py.readthedocs.io/en/stable/reference/config/).

Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started/advanced.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Prisma also allows you to fetch multiple things at once. Instead of doing compli
few of their comments in just a few lines and with full type-safety:

```py
# fetch a post and 3 of it's comments
# fetch a post and 3 of its comments
post = await db.post.find_unique(
where={
'id': post.id,
Expand Down
1 change: 0 additions & 1 deletion docs/getting_started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,6 @@ found post: {
"title": "Hello from prisma!",
"updated_at": "2021-01-04T00:30:35.921000+00:00"
}
post description is "Prisma is a database toolkit and makes databases easy.""
```

## Static type checking
Expand Down
4 changes: 2 additions & 2 deletions docs/getting_started/type-safety.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ All Prisma Client Python methods are fully[^1] statically typed, in this page we

Python has support for _hinting_[^2] at the types of objects.

For example, heres a function without any type hints.
For example, here's a function without any type hints.

```py
def add_numbers(a, b):
return a + b
```

And heres the same function with type hints.
And here's the same function with type hints.

```py
def add_numbers(a: int, b: int) -> int:
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ A prisma schema can define one or more generators, defined by the `generator` bl

A generator determines what assets are created when you run the `prisma generate` command. The `provider` value defines which Prisma Client will be created. In this case, as we want to generate Prisma Client Python, we use the `prisma-client-py` value.

You can also define where the client will be generated to with the `output` option. By default Prisma Client Python will be generated to the same location it was installed to, whether thats inside a virtual environment, the global python installation or anywhere else that python packages can be imported from.
You can also define where the client will be generated to with the `output` option. By default Prisma Client Python will be generated to the same location it was installed to, whether that's inside a virtual environment, the global python installation or anywhere else that python packages can be imported from.

For more options see [configuring Prisma Client Python](https://prisma-client-py.readthedocs.io/en/stable/reference/config/).

Expand Down
2 changes: 1 addition & 1 deletion examples/discord-message-counter/bot.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@


# commands.Bot is only a Generic Type while type checking
# thats why we have to do this little dance around it
# that's why we have to do this little dance around it
if TYPE_CHECKING:
BotBase = commands.Bot['Context']
else:
Expand Down
2 changes: 1 addition & 1 deletion tests/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ ENV DOCKER_TARGETARCH=${TARGETARCH}

# TODO: Using the slim variant is a bit hackier. Better to
# cat and grep /etc/*release*. Also, the [[ ]] command
# is a bash thing so thats why we subshell for the test
# is a bash thing so that's why we subshell for the test
RUN \
if [[ $OS_DISTRO =~ alpine ]]; then \
adduser -u ${PRISMA_USER_ID} -D prisma; \
Expand Down

0 comments on commit 5713263

Please sign in to comment.