From 17fb6b38d1abeface4fb499814c416c80e44b4f4 Mon Sep 17 00:00:00 2001 From: Oliver Hine Date: Wed, 6 Dec 2017 09:50:55 +0000 Subject: [PATCH] Updating documentation to reference execute! instead of evaluate!. Fixes #6 --- dist/latest/index.html | 16 +++++++++++----- docs/content.adoc | 6 +++--- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/dist/latest/index.html b/dist/latest/index.html index e00ec03..00ef584 100644 --- a/dist/latest/index.html +++ b/dist/latest/index.html @@ -4,7 +4,7 @@ - + Urania documentation @@ -424,8 +424,10 @@ .listingblock .pygments .tok-err { border: 1px solid #FF0000 } /* Error */ .listingblock .pygments .tok-k { color: #007020; font-weight: bold } /* Keyword */ .listingblock .pygments .tok-o { color: #666666 } /* Operator */ +.listingblock .pygments .tok-ch { color: #60a0b0; font-style: italic } /* Comment.Hashbang */ .listingblock .pygments .tok-cm { color: #60a0b0; font-style: italic } /* Comment.Multiline */ .listingblock .pygments .tok-cp { color: #007020 } /* Comment.Preproc */ +.listingblock .pygments .tok-cpf { color: #60a0b0; font-style: italic } /* Comment.PreprocFile */ .listingblock .pygments .tok-c1 { color: #60a0b0; font-style: italic } /* Comment.Single */ .listingblock .pygments .tok-cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */ .listingblock .pygments .tok-gd { color: #A00000 } /* Generic.Deleted */ @@ -465,8 +467,10 @@ .listingblock .pygments .tok-mh { color: #40a070 } /* Literal.Number.Hex */ .listingblock .pygments .tok-mi { color: #40a070 } /* Literal.Number.Integer */ .listingblock .pygments .tok-mo { color: #40a070 } /* Literal.Number.Oct */ +.listingblock .pygments .tok-sa { color: #4070a0 } /* Literal.String.Affix */ .listingblock .pygments .tok-sb { color: #4070a0 } /* Literal.String.Backtick */ .listingblock .pygments .tok-sc { color: #4070a0 } /* Literal.String.Char */ +.listingblock .pygments .tok-dl { color: #4070a0 } /* Literal.String.Delimiter */ .listingblock .pygments .tok-sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ .listingblock .pygments .tok-s2 { color: #4070a0 } /* Literal.String.Double */ .listingblock .pygments .tok-se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ @@ -477,9 +481,11 @@ .listingblock .pygments .tok-s1 { color: #4070a0 } /* Literal.String.Single */ .listingblock .pygments .tok-ss { color: #517918 } /* Literal.String.Symbol */ .listingblock .pygments .tok-bp { color: #007020 } /* Name.Builtin.Pseudo */ +.listingblock .pygments .tok-fm { color: #06287e } /* Name.Function.Magic */ .listingblock .pygments .tok-vc { color: #bb60d5 } /* Name.Variable.Class */ .listingblock .pygments .tok-vg { color: #bb60d5 } /* Name.Variable.Global */ .listingblock .pygments .tok-vi { color: #bb60d5 } /* Name.Variable.Instance */ +.listingblock .pygments .tok-vm { color: #bb60d5 } /* Name.Variable.Magic */ .listingblock .pygments .tok-il { color: #40a070 } /* Literal.Number.Integer.Long */ @@ -1035,10 +1041,10 @@

4.1. Caching

urania stores intermediate results in a cache, grouping data sources by their name and mapping their identity to the fetched value. You can run a fetch and get back both the final cache and the results using -urania.core/evaluate! instead of urania.core/run!.

+urania.core/execute! instead of urania.core/run!.

-

Let’s define a simple data source and fetch some results with urania.core/evaluate! to see the cached +

Let’s define a simple data source and fetch some results with urania.core/execute! to see the cached values:

@@ -1049,7 +1055,7 @@

4.1. Caching

(-fetch [_ _] (prom/resolved result))) (deref - (u/evaluate! (Simple. 1 42))) + (u/execute! (Simple. 1 42))) ;; => [42 {"user.Simple" {1 42}}]
@@ -1230,7 +1236,7 @@

8. License

diff --git a/docs/content.adoc b/docs/content.adoc index bb7645f..e013f49 100644 --- a/docs/content.adoc +++ b/docs/content.adoc @@ -425,9 +425,9 @@ While providing a convenient high-level API, `urania` allows you to customize ho `urania` stores intermediate results in a cache, grouping data sources by their name and mapping their identity to the fetched value. You can run a fetch and get back both the final cache and the results using -`urania.core/evaluate!` instead of `urania.core/run!`. +`urania.core/execute!` instead of `urania.core/run!`. -Let's define a simple data source and fetch some results with `urania.core/evaluate!` to see the cached +Let's define a simple data source and fetch some results with `urania.core/execute!` to see the cached values: [source, clojure] @@ -438,7 +438,7 @@ values: (-fetch [_ _] (prom/resolved result))) (deref - (u/evaluate! (Simple. 1 42))) + (u/execute! (Simple. 1 42))) ;; => [42 {"user.Simple" {1 42}}] ----