Skip to content
This repository was archived by the owner on Apr 15, 2025. It is now read-only.

Commit 5713263

Browse files
authored
docs: polishes & typos (#772)
## 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.
1 parent 32dd88a commit 5713263

File tree

7 files changed

+7
-8
lines changed

7 files changed

+7
-8
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ A prisma schema can define one or more generators, defined by the `generator` bl
127127

128128
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.
129129

130-
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.
130+
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.
131131

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

docs/getting_started/advanced.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Prisma also allows you to fetch multiple things at once. Instead of doing compli
121121
few of their comments in just a few lines and with full type-safety:
122122

123123
```py
124-
# fetch a post and 3 of it's comments
124+
# fetch a post and 3 of its comments
125125
post = await db.post.find_unique(
126126
where={
127127
'id': post.id,

docs/getting_started/quickstart.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,6 @@ found post: {
101101
"title": "Hello from prisma!",
102102
"updated_at": "2021-01-04T00:30:35.921000+00:00"
103103
}
104-
post description is "Prisma is a database toolkit and makes databases easy.""
105104
```
106105

107106
## Static type checking

docs/getting_started/type-safety.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ All Prisma Client Python methods are fully[^1] statically typed, in this page we
1111

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

14-
For example, heres a function without any type hints.
14+
For example, here's a function without any type hints.
1515

1616
```py
1717
def add_numbers(a, b):
1818
return a + b
1919
```
2020

21-
And heres the same function with type hints.
21+
And here's the same function with type hints.
2222

2323
```py
2424
def add_numbers(a: int, b: int) -> int:

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ A prisma schema can define one or more generators, defined by the `generator` bl
127127

128128
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.
129129

130-
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.
130+
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.
131131

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

examples/discord-message-counter/bot.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77

88
# commands.Bot is only a Generic Type while type checking
9-
# thats why we have to do this little dance around it
9+
# that's why we have to do this little dance around it
1010
if TYPE_CHECKING:
1111
BotBase = commands.Bot['Context']
1212
else:

tests/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ ENV DOCKER_TARGETARCH=${TARGETARCH}
3030

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

0 commit comments

Comments
 (0)