Skip to content

Commit 7d2117e

Browse files
authored
increment package version in mix.exs and update docs (#101)
1 parent 8278409 commit 7d2117e

File tree

5 files changed

+28
-8
lines changed

5 files changed

+28
-8
lines changed

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## Unreleased
99

10-
[Compare with 0.3.0](https://github.com/nsidnev/edgedb-elixir/compare/v0.3.0...HEAD)
10+
[Compare with 0.4.0](https://github.com/nsidnev/edgedb-elixir/compare/v0.4.0...HEAD)
11+
12+
## [0.4.0] - 2022-08-04
13+
14+
[Compare with 0.3.0](https://github.com/nsidnev/edgedb-elixir/compare/v0.3.0...v0.4.0)
1115

1216
### Added
1317

lib/edgedb.ex

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,8 @@ defmodule EdgeDB do
108108
| {:retry, list(retry_option())}
109109
| {:codecs, list(module())}
110110
| {:connection, module()}
111+
| {:pool, module()}
112+
| {:state, EdgeDB.State.t()}
111113

112114
@typedoc """
113115
Options for `EdgeDB.start_link/1`.
@@ -684,6 +686,13 @@ defmodule EdgeDB do
684686
)
685687
end
686688

689+
@doc """
690+
Open a subtransaction inside an already open transaction.
691+
692+
If an error in subtransaction occurs then subtransaction will automatically rollback.
693+
694+
See `EdgeDB.subtransaction/2` for more information.
695+
"""
687696
@spec subtransaction!(DBConnection.conn(), (DBConnection.conn() -> result())) :: result()
688697
def subtransaction!(conn, callback) do
689698
case subtransaction(conn, callback) do

lib/edgedb/state.ex

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,13 @@ defmodule EdgeDB.State do
77
3. session config.
88
4. global values.
99
10-
The most convenient way to use the `EdgeDB` API to change a part of state.
11-
See `EdgeDB.with_default_module/2`, `EdgeDB.with_module_aliases/2`/`EdgeDB.without_module_aliases/2`,
12-
`EdgeDB.with_config/2`/`EdgeDB.without_config/2`, `EdgeDB.with_globals/2`/`EdgeDB.without_globals/2`
13-
and `EdgeDB.with_state/2` for more information.
10+
The most convenient way to work with the state is to use the `EdgeDB` API to change a required part of
11+
the state.
12+
13+
See `EdgeDB.with_state/2`, `EdgeDB.with_default_module/2`,
14+
`EdgeDB.with_module_aliases/2`/`EdgeDB.without_module_aliases/2`,
15+
`EdgeDB.with_config/2`/`EdgeDB.without_config/2` and
16+
`EdgeDB.with_globals/2`/`EdgeDB.without_globals/2` for more information.
1417
"""
1518

1619
@default_module "default"

lib/edgedb/types/range.ex

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
defmodule EdgeDB.Range do
22
@moduledoc """
3-
An immutable value representing some interval of values.
3+
A value representing some interval of values.
44
55
```elixir
66
iex(1)> {:ok, pid} = EdgeDB.start_link()
@@ -18,7 +18,7 @@ defmodule EdgeDB.Range do
1818
]
1919

2020
@typedoc """
21-
An immutable value representing some interval of values.
21+
A value representing some interval of values.
2222
2323
Fields:
2424
@@ -35,6 +35,10 @@ defmodule EdgeDB.Range do
3535
inc_upper: boolean(),
3636
is_empty: boolean()
3737
}
38+
39+
@typedoc """
40+
A value representing some interval of values.
41+
"""
3842
@type t() :: t(term())
3943

4044
@typedoc """

mix.exs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ defmodule EdgeDB.MixProject do
22
use Mix.Project
33

44
@app :edgedb
5-
@version "0.3.0"
5+
@version "0.4.0"
66
@source_url "https://github.com/nsidnev/edgedb-elixir"
77
@description "EdgeDB driver for Elixir"
88

0 commit comments

Comments
 (0)