Fix typos and RDF.Serialization.Decoder callback spec

This commit is contained in:
Marcel Otto 2018-03-01 13:16:31 +01:00
parent 0a8fe7d870
commit bb0f8e12aa
2 changed files with 5 additions and 4 deletions

View file

@ -14,10 +14,10 @@ This project adheres to [Semantic Versioning](http://semver.org/) and
### Fixed
- Fix `unescape_map` in `parse_helper` for Elixir 1.6 ([@ajkeys](https://github.com/ajkeys)
- Fix `unescape_map` in `parse_helper` for Elixir 1.6 ([@ajkeys](https://github.com/ajkeys))
[Compare v0.3.0...HEAD](https://github.com/marcelotto/rdf-ex/compare/v0.3.0...v0.3.1)
[Compare v0.3.0...v0.3.1](https://github.com/marcelotto/rdf-ex/compare/v0.3.0...v0.3.1)

View file

@ -1,6 +1,6 @@
defmodule RDF.Serialization.Decoder do
@moduledoc """
A behaviour for decoder of strings encoded in a specific `RDF.Serialization` format.
A behaviour for decoders of strings encoded in a specific `RDF.Serialization` format.
"""
@ -10,7 +10,8 @@ defmodule RDF.Serialization.Decoder do
It returns an `{:ok, data}` tuple, with `data` being the deserialized graph or
dataset, or `{:error, reason}` if an error occurs.
"""
@callback decode(String.t, keyword) :: keyword(RDF.Graph.t | RDF.Dataset.t)
@callback decode(String.t, keyword) :: {:ok, RDF.Graph.t | RDF.Dataset.t} |
{:error, any}
@doc """
Decodes a serialized `RDF.Graph` or `RDF.Dataset` from the given string.