Skip to content

Commit

Permalink
chore: fix docs formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
bombillazo committed Feb 7, 2024
1 parent c7aac91 commit c5f5b2d
Showing 1 changed file with 18 additions and 19 deletions.
37 changes: 18 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ await client.connect();
}

{
const result =
await client.queryArray`SELECT ID, NAME FROM PEOPLE WHERE ID = ${1}`;
const result = await client
.queryArray`SELECT ID, NAME FROM PEOPLE WHERE ID = ${1}`;
console.log(result.rows); // [[1, 'Carlos']]
}

Expand All @@ -43,8 +43,8 @@ await client.connect();
}

{
const result =
await client.queryObject`SELECT ID, NAME FROM PEOPLE WHERE ID = ${1}`;
const result = await client
.queryObject`SELECT ID, NAME FROM PEOPLE WHERE ID = ${1}`;
console.log(result.rows); // [{id: 1, name: 'Carlos'}]
}

Expand All @@ -59,8 +59,8 @@ For more examples, visit the documentation available at
The documentation is available on the deno-postgres website
[https://deno-postgres.com/](https://deno-postgres.com/)

Join the [Discord](https://discord.gg/HEdTCvZUSf) as well! It's a good place
to discuss bugs and features before opening issues.
Join the [Discord](https://discord.gg/HEdTCvZUSf) as well! It's a good place to
discuss bugs and features before opening issues.

## Contributing

Expand All @@ -71,17 +71,16 @@ to discuss bugs and features before opening issues.
- https://docs.docker.com/get-docker/
- https://docs.docker.com/compose/install/

- You don't need `deno` installed in your machine to run the tests since it
will be installed in the Docker container when you build it. However, you will
need it to run the linter and formatter locally
- You don't need `deno` installed in your machine to run the tests since it will
be installed in the Docker container when you build it. However, you will need
it to run the linter and formatter locally

- https://deno.land/
- `deno upgrade --version 1.7.1`
- `dvm install 1.7.1 && dvm use 1.7.1`

- You don't need to install Postgres locally on your machine to test
the library, it will run as a service in the Docker container when you build
it
- You don't need to install Postgres locally on your machine to test the
library, it will run as a service in the Docker container when you build it

### Running the tests

Expand All @@ -97,8 +96,8 @@ The build step will check linting and formatting as well and report it to the
command line

It is recommended that you don't rely on any previously initialized data for
your tests instead create all the data you need at the moment of
running the tests
your tests instead create all the data you need at the moment of running the
tests

For example, the following test will create a temporal table that will disappear
once the test has been completed
Expand Down Expand Up @@ -166,10 +165,9 @@ When contributing to the repository, make sure to:
explaining their usage
3. All code must pass the format and lint checks enforced by `deno fmt` and
`deno lint` respectively. The build will only pass the tests if these
conditions are met. Ignore rules will be accepted in the code base when
their respective justification is given in a comment
4. All features and fixes must have a corresponding test added to be
accepted
conditions are met. Ignore rules will be accepted in the code base when their
respective justification is given in a comment
4. All features and fixes must have a corresponding test added to be accepted

## Maintainers guidelines

Expand All @@ -183,4 +181,5 @@ preserved their individual licenses and copyrights.

Everything is licensed under the MIT License.

All additional work is copyright 2018 - 2022 — Bartłomiej Iwańczuk and Steven Guerrero — All rights reserved.
All additional work is copyright 2018 - 2022 — Bartłomiej Iwańczuk and Steven
Guerrero — All rights reserved.

1 comment on commit c5f5b2d

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No typecheck tests failure

This error was most likely caused by incorrect type stripping from the SWC crate

Please report the following failure to https://github.com/denoland/deno with a reproduction of the current commit

Failure log

Please sign in to comment.