Skip to content

Commit 97a5dee

Browse files
committed
minor fixes and typo fixes
1 parent 516f9d0 commit 97a5dee

4 files changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ A PHP library built on the [ShipEngine API](https://shipengine.com) offering low
1616

1717
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
1818
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
19-
**Table of Contents**
19+
## **Table of Contents**
2020

2121
- [Quick Start](#quick-start)
2222
- [Examples](#examples)

docs/addressValidateExample.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Address Validation Documentation
22
================================
3-
ShipEngine allows you to validate an address before using it to create a shipment to ensure accurate delivery
3+
[ShipEngine](www.shipengine.com) allows you to validate an address before using it to create a shipment to ensure accurate delivery
44
of your packages.
55

66
Address validation can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine
@@ -24,8 +24,9 @@ There are two ways to validate an address using this SDK.
2424
requires a `countryCode` which should be the 2 character capitalized abbreviation for a given countryCode.
2525

2626
- **Behavior**: The `validateAddress` method will always return
27-
an [AddressValidateResult](../src/Model/Address/AddressValidateResult.php) object, even in the even that the
28-
address passed in was not *valid*.
27+
an [AddressValidateResult](../src/Model/Address/AddressValidateResult.php) object, and it allows you to determine
28+
whether an address is valid before using it for your shipments. It accepts an address object containing typical
29+
address properties, described below, and will return a normalized address object if the address is valid.
2930

3031
- **Method level configuration** - You can optionally pass in an array that contains `configuration` values to be used
3132
for the current method call. The options are `apiKey`, `baseUrl`, `pageSize`,
@@ -88,7 +89,7 @@ $validated_address = $shipengine->validateAddress($address, ['retries' => 2]);
8889
print_r($validated_address);
8990
```
9091

91-
**Successful Address Validation Output:**: As a raw `AddressValidateResult` object.
92+
**Successful Address Validation Output:** As a raw `AddressValidateResult` object.
9293

9394
```php
9495
ShipEngine\Model\Address\AddressValidateResult Object
@@ -138,7 +139,7 @@ $validated_address = $shipengine->validateAddress($address, ['retries' => 2]);
138139
print_r(json_encode($validated_address, JSON_PRETTY_PRINT)); // Return the AddressValidateResult Type as a JSON string.
139140
```
140141

141-
**Successful Address Validation Output:**: This is the `AddressValidateResult` Type serialized as JSON.
142+
**Successful Address Validation Output:** This is the `AddressValidateResult` Type serialized as JSON.
142143
```json5
143144
{
144145
"valid": true,

src/Message/Events/ShipEngineEvent.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
use DateTime;
66
use ShipEngine\Message\InvalidFieldValueException;
7-
use ShipEngine\Message\ShipEngineException;
87
use ShipEngine\ShipEngineConfig;
98
use Symfony\Component\EventDispatcher\EventDispatcher;
109
use Symfony\Contracts\EventDispatcher\Event;

src/Message/TimeoutException.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
final class TimeoutException extends ShipEngineException
1414
{
1515
/**
16-
* TimeoutException constructor - Instantiates a server-side error.
16+
* TimeoutException constructor - Instantiates a timeout exception.
1717
*
1818
* @param int $retryAfter The amount of time (in SECONDS) to wait before retrying the request.
1919
* @param string|null $source

0 commit comments

Comments
 (0)