Skip to content

docs: fix typos and grammar in SDK documentation #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Avicennasis wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix typos and grammar in SDK documentation #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions documentation/android_tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ LatchClient
.startProximityUnlock() // Starts Proximity Unlock

LatchClient
.stopProximityUnlock() // Stops Proximity Unlock and dispose the listener
.stopProximityUnlock() // Stops Proximity Unlock and dispose of the listener

LatchClient
.proximityUnlockListener()
Expand All @@ -173,7 +173,7 @@ LatchClient
.startProximityUnlock() // Restarts proximity unlock with a new listener
```

We also provide a one-shot proximity unlock functions, similar to `unlock()` and terminates after it unlocks the closest lock.
We also provide one-shot proximity unlock functions, similar to `unlock()`, that terminate after unlocking the closest lock.

```
LatchClient
Expand Down
10 changes: 5 additions & 5 deletions documentation/ios_tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ This function takes two parameters:

`token` - representing optional String value of the Auth0 token

`allAccesses` - flag that indicate if we should load all accesses (partner and non-partner) of the user. (introduced in the version `1.44.0`)
`allAccesses` - flag that indicates if we should load all accesses (partner and non-partner) of the user. (introduced in the version `1.44.0`)

Async/Await

```swift
let token: String? = ... // fetched from Auth0

/*
Optional flag that indicate if we should load all accesses (partner and non-partner) of the user.
Optional flag that indicates if we should load all accesses (partner and non-partner) of the user.
- If not provided, the default value is `false` and will behave as it was previously.
- Setting this flag to `true` will load all devices that user has access to.
*/
Expand All @@ -44,7 +44,7 @@ Completion Block
let token = ... // fetched from Auth0

/*
Optional flag that indicate if we should load all accesses (partner and non-partner) of the user.
Optional flag that indicates if we should load all accesses (partner and non-partner) of the user.
- If not provided, the default value is `false` and will behave as it was previously.
- Setting this flag to `true` will load all devices that user has access to.
*/
Expand All @@ -66,7 +66,7 @@ Latch.initialize(withToken: token) { ... }
```

## Doors and Locks
The list of locks can be retrieved from local cache using `locks()` or fetched from server using fetchLocks()`
The list of locks can be retrieved from local cache using `locks()` or fetched from the server using `fetchLocks()`

`locks()` returns the cached list of locks retrieved during initialization. This works even if the device is offline.
Use `locks()` when you want a quick response or need to support offline access.
Expand Down Expand Up @@ -153,7 +153,7 @@ latch.sync(lockID: lock.id.uuidString) { result in

## Access Logs

Access Logs are providing access logs information for a given lock.
Access Logs provide access log information for a given lock.

Async/Await

Expand Down
6 changes: 3 additions & 3 deletions documentation/partner_app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ All additional SDK functions require that `initialize(...)` has been invoked wit
| ----------------------------- | ----------- |
| `LatchError.invalidToken` | The supplied authorization token is invalid and should be refreshed. |
| `LatchError.permissionDenied` | The current user hasn't granted the app access to use the Latch SDK. |
| `Error` | An unexpected error occured |
| `Error` | An unexpected error occurred |

## Doors and Locks

Expand All @@ -100,7 +100,7 @@ Retrieve all locks accessible to the current user. This list can be used to buil

| Code | Description |
| ------- | ----------- |
| `Error` | An unexpected error occured |
| `Error` | An unexpected error occurred |

## Unlock

Expand Down Expand Up @@ -133,7 +133,7 @@ Either a success or failure.
| `LatchError.concurrentUnlockInProgress` | Only one unlock operation is allowed at a time. |
| `LatchError.lockNotFound` | Failed to find a lock with a unique identifier matching the given lock ID. |
| `LatchError.timeout` | Unlock failed to complete in a reasonable amount of time. |
| `Error` | An unexpected error occured |
| `Error` | An unexpected error occurred |



2 changes: 1 addition & 1 deletion documentation/user_management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Once a user is invited to Latch, a confirmation notification will be delivered t

Having a Latch Account/Password, enables the user to utilize the Latch app and participate in other Partner Apps that are part of the Latch ecosystem.

> Anytime a user is invited to Latch either directly or through a Partner, a confirmation email is sent to the user. User’s can take the optional step of finalizing the Latch account by creating a password enabling them to utilize the Latch App.
> Anytime a user is invited to Latch either directly or through a Partner, a confirmation email is sent to the user. Users can take the optional step of finalizing the Latch account by creating a password enabling them to utilize the Latch App.

Creating a Latch account password and subsequently utilizing the Latch App is a purely optional step by the user and is not a requirement to utilize the Partner App.

Expand Down