Skip to content

Commit

Permalink
increment package version in mix.exs and update docs (#101)
Browse files Browse the repository at this point in the history
  • Loading branch information
nsidnev authored Aug 4, 2022
1 parent 8278409 commit 7d2117e
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 8 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## Unreleased

[Compare with 0.3.0](https://github.com/nsidnev/edgedb-elixir/compare/v0.3.0...HEAD)
[Compare with 0.4.0](https://github.com/nsidnev/edgedb-elixir/compare/v0.4.0...HEAD)

## [0.4.0] - 2022-08-04

[Compare with 0.3.0](https://github.com/nsidnev/edgedb-elixir/compare/v0.3.0...v0.4.0)

### Added

Expand Down
9 changes: 9 additions & 0 deletions lib/edgedb.ex
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,8 @@ defmodule EdgeDB do
| {:retry, list(retry_option())}
| {:codecs, list(module())}
| {:connection, module()}
| {:pool, module()}
| {:state, EdgeDB.State.t()}

@typedoc """
Options for `EdgeDB.start_link/1`.
Expand Down Expand Up @@ -684,6 +686,13 @@ defmodule EdgeDB do
)
end

@doc """
Open a subtransaction inside an already open transaction.
If an error in subtransaction occurs then subtransaction will automatically rollback.
See `EdgeDB.subtransaction/2` for more information.
"""
@spec subtransaction!(DBConnection.conn(), (DBConnection.conn() -> result())) :: result()
def subtransaction!(conn, callback) do
case subtransaction(conn, callback) do
Expand Down
11 changes: 7 additions & 4 deletions lib/edgedb/state.ex
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,13 @@ defmodule EdgeDB.State do
3. session config.
4. global values.
The most convenient way to use the `EdgeDB` API to change a part of state.
See `EdgeDB.with_default_module/2`, `EdgeDB.with_module_aliases/2`/`EdgeDB.without_module_aliases/2`,
`EdgeDB.with_config/2`/`EdgeDB.without_config/2`, `EdgeDB.with_globals/2`/`EdgeDB.without_globals/2`
and `EdgeDB.with_state/2` for more information.
The most convenient way to work with the state is to use the `EdgeDB` API to change a required part of
the state.
See `EdgeDB.with_state/2`, `EdgeDB.with_default_module/2`,
`EdgeDB.with_module_aliases/2`/`EdgeDB.without_module_aliases/2`,
`EdgeDB.with_config/2`/`EdgeDB.without_config/2` and
`EdgeDB.with_globals/2`/`EdgeDB.without_globals/2` for more information.
"""

@default_module "default"
Expand Down
8 changes: 6 additions & 2 deletions lib/edgedb/types/range.ex
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
defmodule EdgeDB.Range do
@moduledoc """
An immutable value representing some interval of values.
A value representing some interval of values.
```elixir
iex(1)> {:ok, pid} = EdgeDB.start_link()
Expand All @@ -18,7 +18,7 @@ defmodule EdgeDB.Range do
]

@typedoc """
An immutable value representing some interval of values.
A value representing some interval of values.
Fields:
Expand All @@ -35,6 +35,10 @@ defmodule EdgeDB.Range do
inc_upper: boolean(),
is_empty: boolean()
}

@typedoc """
A value representing some interval of values.
"""
@type t() :: t(term())

@typedoc """
Expand Down
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ defmodule EdgeDB.MixProject do
use Mix.Project

@app :edgedb
@version "0.3.0"
@version "0.4.0"
@source_url "https://github.com/nsidnev/edgedb-elixir"
@description "EdgeDB driver for Elixir"

Expand Down

0 comments on commit 7d2117e

Please sign in to comment.