Fix documentation

This commit is contained in:
Marcel Otto 2021-11-17 20:42:42 +01:00
parent b0cdb62598
commit 2abb17ff6a
2 changed files with 8 additions and 8 deletions

View file

@ -264,7 +264,7 @@ defmodule RDF.Graph do
options. They have different addition semantics similar to the `add_annotations/3`,
`put_annotations/3` and `put_annotation_properties/3` counterparts.
What should happen with the annotations of statement which got delete during the
What should happen with the annotations of statements which got deleted during the
overwrite, can be controlled with these keyword options:
- `:delete_annotations_on_deleted`: deletes all or some annotations of the deleted
@ -322,7 +322,7 @@ defmodule RDF.Graph do
options. They have different addition semantics similar to the `add_annotations/3`,
`put_annotations/3` and `put_annotation_properties/3` counterparts.
What should happen with the annotations of statement which got delete during the
What should happen with the annotations of statements which got deleted during the
overwrite, can be controlled with these keyword options:
- `:delete_annotations_on_deleted`: deletes all or some annotations of the deleted
@ -382,7 +382,7 @@ defmodule RDF.Graph do
use `RDF.Data.delete/2`.
The optional `:delete_annotations` keyword option allows to set which of
RDF-star annotations of the deleted statements should be deleted.
the RDF-star annotations of the deleted statements should be deleted.
Any of the possible values of `delete_annotations/3` can be provided here.
By default no annotations of the deleted statements will be removed.
Alternatively, the `:add_annotations`, `:put_annotations` or `:put_annotation_properties`
@ -449,7 +449,7 @@ defmodule RDF.Graph do
If `subjects` contains subjects that are not in `graph`, they're simply ignored.
The optional `:delete_annotations` keyword option allows to set which of
RDF-star annotations of the deleted statements should be deleted.
the RDF-star annotations of the deleted statements should be deleted.
Any of the possible values of `delete_annotations/3` can be provided here.
By default no annotations of the deleted statements will be removed.
Alternatively, the `:add_annotations`, `:put_annotations` or `:put_annotation_properties`

View file

@ -28,7 +28,7 @@ defmodule RDF.Star.Statement do
@doc """
Creates a `RDF.Star.Triple` or `RDF.Star.Quad` with proper RDF values.
An error is raised when the given elements are not coercible to RDF values.
An error is raised when the given elements are not coercible to RDF-star values.
Note: The `RDF.statement` function is a shortcut to this function.
@ -53,7 +53,7 @@ defmodule RDF.Star.Statement do
@doc """
Creates a `RDF.Star.Statement` tuple with proper RDF values.
An error is raised when the given elements are not coercible to RDF values.
An error is raised when the given elements are not coercible to RDF-star values.
## Examples
@ -120,9 +120,9 @@ defmodule RDF.Star.Statement do
def valid_graph_name?(any), do: RDF.Statement.valid_graph_name?(any)
@doc """
Checks if the given tuple is a RDF-star statement annotating a triple on subject or object position.
Checks if the given tuple is a RDF-star statement with a quoted triple on subject or object position.
Note: This function won't check if the given tuple or the annotated triple is valid.
Note: This function won't check if the given tuple or the quoted triple is valid.
Use `valid?/1` for this purpose.
## Examples