Skip to content

Commit 6f1c650

Browse files
committed
docs: fix typos and grammar in documentation
- Fix spelling of "occurred" in overview.mdx - Add missing bracket in libraries.mdx Drupal link - Fix spelling of "PostgreSQL" in self-host.mdx - Change "an list" to "a list" in autocomplete.mdx - Remove duplicate "the" in bulk.mdx - Clarify widesearch parameter description in reverse-geocode.mdx
1 parent 0a8ee67 commit 6f1c650

6 files changed

Lines changed: 6 additions & 6 deletions

File tree

docs/libraries.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ title: "Libraries"
1616
## PHP
1717

1818
- [LaravelPostcodes](https://github.com/JustSteveKing/LaravelPostcodes) by [Steve McDougall](https://github.com/JustSteveKing)
19-
- [Postcodes.io API module for Drupal](https://www.drupal.org/project/postcodes_io_api) by Dakku Singh](https://github.com/dakkusingh)
19+
- [Postcodes.io API module for Drupal](https://www.drupal.org/project/postcodes_io_api) by [Dakku Singh](https://github.com/dakkusingh)
2020
- [postcodes-io-bundle](https://github.com/boxuk/postcodes-io-bundle) by the people at [Box UK](https://www.boxuk.com/). Read the [blog post](https://www.boxuk.com/insight/)
2121
- [(adityamenon) postcodes-io laravel package](https://github.com/adityamenon/postcodes-io-laravel) by [Aditya Menon](https://adityamenon.co/)
2222
- [PHP Class for Postcodes.io](https://github.com/ryryan/Postcodes-IO-PHP) by Ryan

docs/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ To perform one-time data extraction tasks using SQL, see our [local data extract
104104

105105
## Error Handling
106106

107-
To check for errors, examine the HTTP response code. 200 response indicates success while any other code will provide important information about why an error occured.
107+
To check for errors, examine the HTTP response code. 200 response indicates success while any other code will provide important information about why an error occurred.
108108

109109
Alternatively, you can examine status code in the 'status' property in the result body.
110110

docs/postcode/autocomplete.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ sidebar_label: "Autocomplete"
33
title: "Autocomplete a Postcode"
44
---
55

6-
Convenient method to return an list of matching postcodes.
6+
Convenient method to return a list of matching postcodes.
77

88
## Endpoint
99

docs/postcode/bulk.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This endpoint allows you to retrieve data for multiple postcodes in a single req
77

88
Returns matching postcode data for each valid postcode provided. If a postcode is not found, its result will be null.
99

10-
For more details, see the [the API Documentation](/docs/api/bulk-postcode-lookup).
10+
For more details, see the [API Documentation](/docs/api/bulk-postcode-lookup).
1111

1212
## Endpoint
1313

docs/postcode/reverse-geocode.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,4 +88,4 @@ https://api.postcodes.io/postcodes?lon=-0.127&lat=51.507
8888
| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ----------------------- | ------------------ |
8989
| `limit` | Limits number of postcode matches to return | 10 | Maximum value is 100 | `&limit=5` |
9090
| `radius` | Sets search radius in meters | 100m | Maximum value is 2,000m | `&radius=500` |
91-
| `widesearch` | Enables a wide area search up to 20km radius, but returns a maximum of 10 results. When set to `true`, any `radius` over 10 and `limit` parameters are ignored | `false` | - | `&widesearch=true` |
91+
| `widesearch` | Enables a wide area search up to 20km radius, but returns a maximum of 10 results. When set to `true`, any `radius` and `limit` parameters are ignored | `false` | - | `&widesearch=true` |

docs/self-host.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,4 +57,4 @@ Example Usage:
5757
$ docker run -p 5432 -e POSTGRES_USER=postcodesio -e POSTGRES_DB=postcodesiodb -e POSTGRES_PASSWORD=password idealpostcodes/postcodes.io.db
5858
```
5959

60-
As this contains the official PostreSQL base image, the available configuration environment variables are documented [here](https://hub.docker.com/_/postgres/)
60+
As this contains the official PostgreSQL base image, the available configuration environment variables are documented [here](https://hub.docker.com/_/postgres/)

0 commit comments

Comments
 (0)