better docs for agregators

jitsedesmet · Oct 10, 2024 · 056f453 · 056f453
1 parent b1f29dc
commit 056f453
Show file tree

Hide file tree

Showing 83 changed files with 230 additions and 107 deletions.
diff --git a/packages/actor-bindings-aggregator-factory-average/README.md b/packages/actor-bindings-aggregator-factory-average/README.md
@@ -3,7 +3,7 @@
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-bindings-aggregator-factory-average.svg)](https://www.npmjs.com/package/@comunica/actor-bindings-aggregator-factory-average)
 
 A [bindings aggregator factory](https://github.com/comunica/comunica/tree/master/packages/bus-bindings-aggregator-factory) actor
-that constructs a bindings aggregator capable of evaluating average.
+that constructs a bindings aggregator capable of evaluating [avg](https://www.w3.org/TR/sparql11-query/#defn_aggAvg).
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-bindings-aggregator-factory-average/rename.ts b/packages/actor-bindings-aggregator-factory-average/rename.ts
diff --git a/packages/actor-bindings-aggregator-factory-count/README.md b/packages/actor-bindings-aggregator-factory-count/README.md
@@ -3,7 +3,7 @@
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-bindings-aggregator-factory-count.svg)](https://www.npmjs.com/package/@comunica/actor-bindings-aggregator-factory-count)
 
 A [bindings aggregator factory](https://github.com/comunica/comunica/tree/master/packages/bus-bindings-aggregator-factory) actor
-that constructs a bindings aggregator capable of evaluating count.
+that constructs a bindings aggregator capable of evaluating [count](https://www.w3.org/TR/sparql11-query/#defn_aggCount).
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-bindings-aggregator-factory-group-concat/README.md b/packages/actor-bindings-aggregator-factory-group-concat/README.md
@@ -3,7 +3,7 @@
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-bindings-aggregator-factory-group-concat.svg)](https://www.npmjs.com/package/@comunica/actor-bindings-aggregator-factory-group-concat)
 
 A [bindings aggregator factory](https://github.com/comunica/comunica/tree/master/packages/bus-bindings-aggregator-factory) actor
-that constructs a bindings aggregator capable of evaluating group-concat.
+that constructs a bindings aggregator capable of evaluating [group-concat](https://www.w3.org/TR/sparql11-query/#defn_aggGroupConcat).
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-bindings-aggregator-factory-max/README.md b/packages/actor-bindings-aggregator-factory-max/README.md
@@ -3,7 +3,7 @@
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-bindings-aggregator-factory-max.svg)](https://www.npmjs.com/package/@comunica/actor-bindings-aggregator-factory-max)
 
 A [bindings aggregator factory](https://github.com/comunica/comunica/tree/master/packages/bus-bindings-aggregator-factory) actor
-that constructs a bindings aggregator capable of evaluating max.
+that constructs a bindings aggregator capable of evaluating [max](https://www.w3.org/TR/sparql11-query/#defn_aggMax).
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-bindings-aggregator-factory-min/README.md b/packages/actor-bindings-aggregator-factory-min/README.md
@@ -3,7 +3,7 @@
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-bindings-aggregator-factory-min.svg)](https://www.npmjs.com/package/@comunica/actor-bindings-aggregator-factory-min)
 
 A [bindings aggregator factory](https://github.com/comunica/comunica/tree/master/packages/bus-bindings-aggregator-factory) actor
-that constructs a bindings aggregator capable of evaluating min.
+that constructs a bindings aggregator capable of evaluating [min](https://www.w3.org/TR/sparql11-query/#defn_aggMin).
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-bindings-aggregator-factory-sample/README.md b/packages/actor-bindings-aggregator-factory-sample/README.md
@@ -3,7 +3,7 @@
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-bindings-aggregator-factory-sample.svg)](https://www.npmjs.com/package/@comunica/actor-bindings-aggregator-factory-sample)
 
 A [bindings aggregator factory](https://github.com/comunica/comunica/tree/master/packages/bus-bindings-aggregator-factory) actor
-that constructs a bindings aggregator capable of evaluating sample.
+that constructs a bindings aggregator capable of evaluating [sample](https://www.w3.org/TR/sparql11-query/#defn_aggSample).
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-bindings-aggregator-factory-sum/README.md b/packages/actor-bindings-aggregator-factory-sum/README.md
@@ -3,7 +3,7 @@
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-bindings-aggregator-factory-sum.svg)](https://www.npmjs.com/package/@comunica/actor-bindings-aggregator-factory-sum)
 
 A [bindings aggregator factory](https://github.com/comunica/comunica/tree/master/packages/bus-bindings-aggregator-factory) actor
-that constructs a bindings aggregator capable of evaluating sum.
+that constructs a bindings aggregator capable of evaluating [sum](https://www.w3.org/TR/sparql11-query/#defn_aggSum).
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-bindings-aggregator-factory-wildcard-count/README.md b/packages/actor-bindings-aggregator-factory-wildcard-count/README.md
@@ -3,7 +3,7 @@
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-bindings-aggregator-factory-wildcard-count.svg)](https://www.npmjs.com/package/@comunica/actor-bindings-aggregator-factory-wildcard-count)
 
 A [bindings aggregator factory](https://github.com/comunica/comunica/tree/master/packages/bus-bindings-aggregator-factory) actor
-that constructs a bindings aggregator capable of evaluating wildcard-count.
+that constructs a bindings aggregator capable of evaluating [wildcard-count](https://www.w3.org/TR/sparql11-query/#defn_aggCount).
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-function-factory-term-abs/README.md b/packages/actor-function-factory-term-abs/README.md
@@ -2,7 +2,9 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-function-factory-term-function-abs.svg)](https://www.npmjs.com/package/@comunica/actor-function-factory-term-abs)
 
-A comunica Term Function Abs Function Factory Actor.
+A [function factory](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory) actor
+that constructs a [term function](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory/lib/ActorFunctionFactory.ts)
+capable of evaluating the [Abs](https://www.w3.org/TR/sparql11-query/#func-abs) function.
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-function-factory-term-addition/README.md b/packages/actor-function-factory-term-addition/README.md
@@ -2,7 +2,9 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-function-factory-term-function-addition.svg)](https://www.npmjs.com/package/@comunica/actor-function-factory-term-addition)
 
-A comunica Term Function Addition Function Factory Actor.
+A [function factory](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory) actor
+that constructs a [term function](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory/lib/ActorFunctionFactory.ts)
+capable of evaluating the [Addition](https://www.w3.org/TR/sparql11-query/#func-a) function.
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-function-factory-term-ceil/README.md b/packages/actor-function-factory-term-ceil/README.md
@@ -2,7 +2,9 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-function-factory-term-function-ceil.svg)](https://www.npmjs.com/package/@comunica/actor-function-factory-term-ceil)
 
-A comunica Term Function Ceil Function Factory Actor.
+A [function factory](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory) actor
+that constructs a [term function](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory/lib/ActorFunctionFactory.ts)
+capable of evaluating the [Ceil](https://www.w3.org/TR/sparql11-query/#func-datatype) function.
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-function-factory-term-contains/README.md b/packages/actor-function-factory-term-contains/README.md
@@ -2,7 +2,9 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-function-factory-term-function-contains.svg)](https://www.npmjs.com/package/@comunica/actor-function-factory-term-contains)
 
-A comunica Term Function Contains Function Factory Actor.
+A [function factory](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory) actor
+that constructs a [term function](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory/lib/ActorFunctionFactory.ts)
+capable of evaluating the [Contains](https://www.w3.org/TR/sparql11-query/#func-datatype) function.
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-function-factory-term-datatype/README.md b/packages/actor-function-factory-term-datatype/README.md
@@ -2,7 +2,9 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-function-factory-term-function-datatype.svg)](https://www.npmjs.com/package/@comunica/actor-function-factory-term-datatype)
 
-A comunica Term Function Datatype Function Factory Actor.
+A [function factory](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory) actor
+that constructs a [term function](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory/lib/ActorFunctionFactory.ts)
+capable of evaluating the [Datatype](https://www.w3.org/TR/sparql11-query/#func-datatype) function.
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-function-factory-term-day/README.md b/packages/actor-function-factory-term-day/README.md
@@ -2,7 +2,9 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-function-factory-term-function-day.svg)](https://www.npmjs.com/package/@comunica/actor-function-factory-term-day)
 
-A comunica Term Function Day Function Factory Actor.
+A [function factory](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory) actor
+that constructs a [term function](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory/lib/ActorFunctionFactory.ts)
+capable of evaluating the [Day](https://www.w3.org/TR/sparql11-query/#func-datatype) function.
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-function-factory-term-division/README.md b/packages/actor-function-factory-term-division/README.md
@@ -2,7 +2,9 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-function-factory-term-function-division.svg)](https://www.npmjs.com/package/@comunica/actor-function-factory-term-division)
 
-A comunica Term Function Division Function Factory Actor.
+A [function factory](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory) actor
+that constructs a [term function](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory/lib/ActorFunctionFactory.ts)
+capable of evaluating the [Division](https://www.w3.org/TR/sparql11-query/#func-datatype) function.
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-function-factory-term-encode-for-uri/README.md b/packages/actor-function-factory-term-encode-for-uri/README.md
@@ -2,7 +2,9 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-function-factory-term-function-encode-for-uri.svg)](https://www.npmjs.com/package/@comunica/actor-function-factory-term-encode-for-uri)
 
-A comunica Term Function Encode For Uri Function Factory Actor.
+A [function factory](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory) actor
+that constructs a [term function](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory/lib/ActorFunctionFactory.ts)
+capable of evaluating the [Encode For Uri](https://www.w3.org/TR/sparql11-query/#func-datatype) function.
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-function-factory-term-equality/README.md b/packages/actor-function-factory-term-equality/README.md
@@ -2,7 +2,9 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-function-factory-term-function-equality.svg)](https://www.npmjs.com/package/@comunica/actor-function-factory-term-equality)
 
-A comunica Term Function Equality Function Factory Actor.
+A [function factory](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory) actor
+that constructs a [term function](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory/lib/ActorFunctionFactory.ts)
+capable of evaluating the [Equality](https://www.w3.org/TR/sparql11-query/#func-datatype) function.
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-function-factory-term-floor/README.md b/packages/actor-function-factory-term-floor/README.md
@@ -2,7 +2,9 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-function-factory-term-function-floor.svg)](https://www.npmjs.com/package/@comunica/actor-function-factory-term-floor)
 
-A comunica Term Function Floor Function Factory Actor.
+A [function factory](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory) actor
+that constructs a [term function](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory/lib/ActorFunctionFactory.ts)
+capable of evaluating the [Floor](https://www.w3.org/TR/sparql11-query/#func-datatype) function.
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-function-factory-term-greater-than-equal/README.md b/packages/actor-function-factory-term-greater-than-equal/README.md
@@ -2,7 +2,9 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-function-factory-term-function-greater-than-equal.svg)](https://www.npmjs.com/package/@comunica/actor-function-factory-term-greater-than-equal)
 
-A comunica Term Function Greater Than Equal Function Factory Actor.
+A [function factory](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory) actor
+that constructs a [term function](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory/lib/ActorFunctionFactory.ts)
+capable of evaluating the [Greater Than Equal](https://www.w3.org/TR/sparql11-query/#func-datatype) function.
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-function-factory-term-greater-than/README.md b/packages/actor-function-factory-term-greater-than/README.md
@@ -2,7 +2,9 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-function-factory-term-function-greater-than.svg)](https://www.npmjs.com/package/@comunica/actor-function-factory-term-greater-than)
 
-A comunica Term Function Greater Than Function Factory Actor.
+A [function factory](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory) actor
+that constructs a [term function](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory/lib/ActorFunctionFactory.ts)
+capable of evaluating the [Greater Than](https://www.w3.org/TR/sparql11-query/#func-datatype) function.
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-function-factory-term-hours/README.md b/packages/actor-function-factory-term-hours/README.md
@@ -2,7 +2,9 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-function-factory-term-function-hours.svg)](https://www.npmjs.com/package/@comunica/actor-function-factory-term-hours)
 
-A comunica Term Function Hours Function Factory Actor.
+A [function factory](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory) actor
+that constructs a [term function](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory/lib/ActorFunctionFactory.ts)
+capable of evaluating the [Hours](https://www.w3.org/TR/sparql11-query/#func-datatype) function.
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-function-factory-term-inequality/README.md b/packages/actor-function-factory-term-inequality/README.md
@@ -2,7 +2,9 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-function-factory-term-function-inequality.svg)](https://www.npmjs.com/package/@comunica/actor-function-factory-term-inequality)
 
-A comunica Term Function Inequality Function Factory Actor.
+A [function factory](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory) actor
+that constructs a [term function](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory/lib/ActorFunctionFactory.ts)
+capable of evaluating the [Inequality](https://www.w3.org/TR/sparql11-query/#func-datatype) function.
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-function-factory-term-iri/README.md b/packages/actor-function-factory-term-iri/README.md
@@ -2,7 +2,9 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-function-factory-term-function-iri.svg)](https://www.npmjs.com/package/@comunica/actor-function-factory-term-iri)
 
-A comunica Term Function Iri Function Factory Actor.
+A [function factory](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory) actor
+that constructs a [term function](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory/lib/ActorFunctionFactory.ts)
+capable of evaluating the [Iri](https://www.w3.org/TR/sparql11-query/#func-datatype) function.
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).

diff --git a/packages/actor-function-factory-term-is-blank/README.md b/packages/actor-function-factory-term-is-blank/README.md
@@ -2,7 +2,9 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-function-factory-term-function-is-blank.svg)](https://www.npmjs.com/package/@comunica/actor-function-factory-term-is-blank)
 
-A comunica Term Function Is Blank Function Factory Actor.
+A [function factory](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory) actor
+that constructs a [term function](https://github.com/comunica/comunica/tree/master/packages/bus-function-factory/lib/ActorFunctionFactory.ts)
+capable of evaluating the [Is Blank](https://www.w3.org/TR/sparql11-query/#func-datatype) function.
 
 This module is part of the [Comunica framework](https://github.com/comunica/comunica),
 and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).