Skip to content

Commit c599bd1

Browse files
committed
Clarify breaking change in CHANGELOG
1 parent e3c3e45 commit c599bd1

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

CHANGELOG.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
1212
### Added
1313
- **[BREAKING]** Optional `metadata` parameter of type `grpc.Metadata` to the
1414
`DgraphClientStub` methods. `options` parameter moved to the third position
15-
to conform with the `grpc` package API. Methods affected -
16-
`DgraphClient#alter`, `Txn#query`, `Txn#queryWithVars`, `Txn#mutate`,
17-
`Txn#commit` and `Txn#discard`.
15+
to conform with the `grpc` package API.
16+
17+
Methods affected - `DgraphClient#alter`, `Txn#query`, `Txn#queryWithVars`,
18+
`Txn#mutate`, `Txn#commit` and `Txn#discard`.
19+
20+
To upgrade to this version, if using any of these methods with the `options`
21+
parameter, simply add a `null` argument before the `options` argument. For
22+
example, `client.alter(options)` becomes `client.alter(null, options)`
1823

1924
## [v1.1.2] - 2018-03-07
2025

0 commit comments

Comments
 (0)