Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
caike committed May 31, 2024
1 parent 7c389ed commit 7232c55
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions lib/xogmios/chain_sync.ex
Original file line number Diff line number Diff line change
Expand Up @@ -131,12 +131,12 @@ defmodule Xogmios.ChainSync do
end

@doc """
Issues a synchronous message for reading the next block.
Potentially useful for building chain indexers with support for backpressure mechanism.
> #### Warning {: .warning}
>
> This is a highly experimental function and should not be relied on just yet.
Issues a synchronous message for reading the next block.
Potentially useful for building chain indexers with support for backpressure mechanism.
"""
@spec read_next_block(pid()) :: {:ok, block :: map()} | :error
def read_next_block(pid) do
Expand Down

0 comments on commit 7232c55

Please sign in to comment.