Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating documentation to reference execute! instead of evaluate!. Fixes #6 #8

Merged
merged 1 commit into from
Dec 6, 2017
Merged

Updating documentation to reference execute! instead of evaluate!. Fixes #6 #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions dist/latest/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8">
<!--[if IE]><meta http-equiv="X-UA-Compatible" content="IE=edge"><![endif]-->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 1.5.3">
<meta name="generator" content="Asciidoctor 1.5.4">
<meta name="author" content="Funcool">
<title>Urania documentation</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700">
Expand Down Expand Up @@ -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 */
Expand Down Expand Up @@ -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 */
Expand All @@ -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 */
</style>
</head>
Expand Down Expand Up @@ -1035,10 +1041,10 @@ <h3 id="caching"><a class="link" href="#caching">4.1. Caching</a></h3>
<div class="paragraph">
<p><code>urania</code> 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
<code>urania.core/evaluate!</code> instead of <code>urania.core/run!</code>.</p>
<code>urania.core/execute!</code> instead of <code>urania.core/run!</code>.</p>
</div>
<div class="paragraph">
<p>Let&#8217;s define a simple data source and fetch some results with <code>urania.core/evaluate!</code> to see the cached
<p>Let&#8217;s define a simple data source and fetch some results with <code>urania.core/execute!</code> to see the cached
values:</p>
</div>
<div class="listingblock">
Expand All @@ -1049,7 +1055,7 @@ <h3 id="caching"><a class="link" href="#caching">4.1. Caching</a></h3>
<span class="tok-p">(</span><span class="tok-nf">-fetch</span> <span class="tok-p">[</span><span class="tok-nv">_</span> <span class="tok-nv">_</span><span class="tok-p">]</span> <span class="tok-p">(</span><span class="tok-nf">prom/resolved</span> <span class="tok-nv">result</span><span class="tok-p">)))</span>

<span class="tok-p">(</span><span class="tok-nf">deref</span>
<span class="tok-p">(</span><span class="tok-nf">u/evaluate!</span> <span class="tok-p">(</span><span class="tok-nf">Simple.</span> <span class="tok-mi">1</span> <span class="tok-mi">42</span><span class="tok-p">)))</span>
<span class="tok-p">(</span><span class="tok-nf">u/execute!</span> <span class="tok-p">(</span><span class="tok-nf">Simple.</span> <span class="tok-mi">1</span> <span class="tok-mi">42</span><span class="tok-p">)))</span>
<span class="tok-c1">;; =&gt; [42 {&quot;user.Simple&quot; {1 42}}]</span></code></pre>
</div>
</div>
Expand Down Expand Up @@ -1230,7 +1236,7 @@ <h2 id="license"><a class="link" href="#license">8. License</a></h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2016-03-02 11:50:34 CET
Last updated 2017-12-06 09:49:56 GMT
</div>
</div>
</body>
Expand Down
6 changes: 3 additions & 3 deletions docs/content.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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}}]
----

Expand Down