Skip to content

Commit

Permalink
Fix misc. spelling issues in docs (#1083)
Browse files Browse the repository at this point in the history
* Update CHANGELOG.md
* Update CONTRIBUTING.md
* Update README.md
  • Loading branch information
nnsW3 authored Nov 27, 2024
1 parent 24c5032 commit 25ff204
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -298,7 +298,7 @@ interface FeeDistribution {

### Added
- `rpc.server.simulateTransaction` now supports an optional `stateChanges?: LedgerEntryChange[]` field ([#963](https://github.com/stellar/js-stellar-sdk/pull/963)):
* If `Before` is omitted, it constitutes a creation, if `After` is omitted, it constitutes a deletions, note that `Before` and `After` cannot be be omitted at the same time. Each item follows this schema:
* If `Before` is omitted, it constitutes a creation, if `After` is omitted, it constitutes a deletions, note that `Before` and `After` cannot be omitted at the same time. Each item follows this schema:

```typescript
interface LedgerEntryChange {
Expand Down Expand Up @@ -348,7 +348,7 @@ import {
+import { Spec } from '@stellar/stellar-sdk/contract'
```

- Previously, `AssembledTransaction.signAndSend()` would return a `SentTransaction` even if the transaction never finalized. That is, if it successfully sent the transaction to the network, but the transaction was still `status: 'PENDING'`, then it would `console.error` an error message, but return the indeterminate transaction anyhow. **It now throws** a `SentTransaction.Errors.TransactionStillPending` error with that error message instead ([#962](https://github.com/stellar/js-stellar-sdk/pull/962)).
- Previously, `AssembledTransaction.signAndSend()` would return a `SentTransaction` even if the transaction was never finalized. That is, if it successfully sent the transaction to the network, but the transaction was still `status: 'PENDING'`, then it would `console.error` an error message, but return the indeterminate transaction anyhow. **It now throws** a `SentTransaction.Errors.TransactionStillPending` error with that error message instead ([#962](https://github.com/stellar/js-stellar-sdk/pull/962)).

### Deprecated

Expand Down Expand Up @@ -732,7 +732,7 @@ Refer to the release notes for the betas (e.g. [v9.0.0-beta.0](https://github.co

### Updates

- Updates the following SEP-10 utility functions to be compilant with the protocols ([#709](https://github.com/stellar/js-stellar-sdk/pull/709/), [stellar-protocol/#1036](https://github.com/stellar/stellar-protocol/pull/1036))
- Updates the following SEP-10 utility functions to be compliant with the protocols ([#709](https://github.com/stellar/js-stellar-sdk/pull/709/), [stellar-protocol/#1036](https://github.com/stellar/stellar-protocol/pull/1036))
- Updated `utils.buildChallengeTx()` to accept muxed accounts (`M...`) for client account IDs
- Updated `utils.buildChallengeTx()` to accept a `memo` parameter to attach to the challenge transaction
- Updated `utils.readChallengeTx()` to provide a `memo` property in the returned object
Expand Down Expand Up @@ -1052,7 +1052,7 @@ The following functions were renamed:
- `xdr.OperationType.setOption()` -> `xdr.OperationType.setOptions()`
- `xdr.OperationType.manageDatum()` -> `xdr.OperationType.manageData()`

The following enum values were rename in `OperationType`:
The following enum values were renamed in `OperationType`:

- `setOption` -> `setOptions`
- `manageDatum` -> `manageData`
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ In fact, you should follow [the steps there](https://github.com/stellar/js-stell
}
```

- [ ] Finally, run `yarn` so that the dependency is pulled (ensuring its a valid version) and the lockfile is updated with the latest integrity details. You can now commit the change and PR accordingly.
- [ ] Finally, run `yarn` so that the dependency is pulled (ensuring it's a valid version) and the lockfile is updated with the latest integrity details. You can now commit the change and PR accordingly.

Note that new versions will be published to npm **and** Bower by GitHub Actions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ You can use a CDN:
<script src="https://cdnjs.cloudflare.com/ajax/libs/stellar-sdk/{version}/stellar-sdk.js"></script>
```

Note that this method relies using a third party to host the JS library. This may not be entirely secure. You can self-host it via [Bower](http://bower.io):
Note that this method relies on using a third party to host the JS library. This may not be entirely secure. You can self-host it via [Bower](http://bower.io):

```shell
bower install @stellar/stellar-sdk
Expand Down

0 comments on commit 25ff204

Please sign in to comment.