Skip to content
Browse files

Update generated docs

  • Loading branch information...
1 parent fc7f55c commit 9817188d9505898c0b0b0ef503e094f011834ac3 @josevalim josevalim committed Dec 4, 2012
View
10 docs/master/Bitwise.html
@@ -137,28 +137,28 @@
<h2>Macros</h2>
<div class="detail">
<p class="signature" id="&amp;&amp;&amp;/2">
- <strong>&amp;&amp;&amp;(left, right)</strong>
+ <strong>left &amp;&amp;&amp; right</strong>
</p>
<div class="docstring"><p>Bitwise and as operator.</p>
</div>
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/bitwise.ex#L67" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&lt;&lt;&lt;/2">
- <strong>&lt;&lt;&lt;(left, right)</strong>
+ <strong>left &lt;&lt;&lt; right</strong>
</p>
<div class="docstring"><p>Arithmetic bitshift left as operator.</p>
</div>
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/bitwise.ex#L109" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&gt;&gt;&gt;/2">
- <strong>&gt;&gt;&gt;(left, right)</strong>
+ <strong>left &gt;&gt;&gt; right</strong>
</p>
<div class="docstring"><p>Arithmetic bitshift right as operator.</p>
</div>
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/bitwise.ex#L123" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="^^^/2">
- <strong>^^^(left, right)</strong>
+ <strong>left ^^^ right</strong>
</p>
<div class="docstring"><p>Bitwise xor as operator.</p>
</div>
@@ -220,7 +220,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/bitwise.ex#L88" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="|||/2">
- <strong>|||(left, right)</strong>
+ <strong>left ||| right</strong>
</p>
<div class="docstring"><p>Bitwise or as operator.</p>
</div>
View
131 docs/master/Dict.html
@@ -143,6 +143,66 @@
+ <h2>Callbacks summary</h2>
+ <ul class="summary">
+ <li>
+ <span class="summary_signature">
+ <a href="#values/1">values/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#update/3">update/3</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#to_list/1">to_list/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#size/1">size/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#put/3">put/3</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#merge/3">merge/3</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#keys/1">keys/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#has_key?/2">has_key?/2</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#get/3">get/3</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#empty/1">empty/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#delete/2">delete/2</a>
+ </span>
+</li>
+
+ </ul>
+
<div id="functions_details" class="details_list">
@@ -354,6 +414,77 @@
+ <div id="callbacks_details" class="details_list">
+ <h2>Callbacks</h2>
+ <div class="detail">
+ <p class="signature" id="values/1">
+ <strong>values(t())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L45" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="update/3">
+ <strong>update(t(), key(), (value() -&gt; value()))</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L44" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="to_list/1">
+ <strong>to_list(t())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L43" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="size/1">
+ <strong>size(t())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L42" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="put/3">
+ <strong>put(t(), key(), value())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L41" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="merge/3">
+ <strong>merge(t(), t(), (key(), value(), value() -&gt; value()))</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L40" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="keys/1">
+ <strong>keys(t())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L39" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="has_key?/2">
+ <strong>has_key?(t(), key())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L38" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="get/3">
+ <strong>get(t(), key(), value())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L37" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="empty/1">
+ <strong>empty(t())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L36" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="delete/2">
+ <strong>delete(t(), key())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L35" target="_blank" class="view_source">Source</a>
+</div>
+ </div>
+
</div>
</body>
</html>
View
2 docs/master/EEx.Engine.html
@@ -23,8 +23,6 @@
<h1>
EEx.Engine
- <small>behaviour</small>
-
</h1>
View
76 docs/master/ExUnit.Formatter.html
@@ -46,12 +46,88 @@
+ <h2>Callbacks summary</h2>
+ <ul class="summary">
+ <li>
+ <span class="summary_signature">
+ <a href="#test_finished/3">test_finished/3</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#test_started/2">test_started/2</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#case_finished/1">case_finished/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#case_started/1">case_started/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#suite_finished/0">suite_finished/0</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#suite_started/0">suite_started/0</a>
+ </span>
+</li>
+ </ul>
+
+
+ <div id="callbacks_details" class="details_list">
+ <h2>Callbacks</h2>
+ <div class="detail">
+ <p class="signature" id="test_finished/3">
+ <strong>test_finished(test_case(), test(), result())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/ex_unit/lib/ex_unit/formatter.ex#L20" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="test_started/2">
+ <strong>test_started(test_case(), test())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/ex_unit/lib/ex_unit/formatter.ex#L19" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="case_finished/1">
+ <strong>case_finished(test_case())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/ex_unit/lib/ex_unit/formatter.ex#L17" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="case_started/1">
+ <strong>case_started(test_case())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/ex_unit/lib/ex_unit/formatter.ex#L16" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="suite_finished/0">
+ <strong>suite_finished()</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/ex_unit/lib/ex_unit/formatter.ex#L14" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="suite_started/0">
+ <strong>suite_started()</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/ex_unit/lib/ex_unit/formatter.ex#L13" target="_blank" class="view_source">Source</a>
+</div>
+ </div>
+
</div>
</body>
</html>
View
10 docs/master/Kernel.SpecialForms.html
@@ -153,7 +153,7 @@
<h2>Macros</h2>
<div class="detail">
<p class="signature" id="&lt;&lt;&gt;&gt;/1">
- <strong>&lt;&lt;&gt;&gt;(args)</strong>
+ <strong>&lt;&lt;args&gt;&gt;</strong>
</p>
<div class="docstring"><p>Defines a new bitstring.</p>
@@ -166,7 +166,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel/special_forms.ex#L46" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="[]/1">
- <strong>[](args)</strong>
+ <strong>[args]</strong>
</p>
<div class="docstring"><p>Defines a new list.</p>
@@ -206,7 +206,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel/special_forms.ex#L197" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="__aliases__/1">
- <strong>__aliases__(args)</strong>
+ <strong>args</strong>
</p>
<div class="docstring"><p>This is the special form used to hold aliases information.
It is usually compiled to an atom:</p>
@@ -249,7 +249,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel/special_forms.ex#L485" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="__block__/1">
- <strong>__block__(args)</strong>
+ <strong>args</strong>
</p>
<div class="docstring"><p>This is the special form used whenever we have a block
of expressions in Elixir. This special form is private
@@ -677,7 +677,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel/special_forms.ex#L368" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="{}/1">
- <strong>{}(args)</strong>
+ <strong>{args}</strong>
</p>
<div class="docstring"><p>Defines a new tuple.</p>
View
56 docs/master/Kernel.html
@@ -1738,7 +1738,7 @@
<h2>Macros</h2>
<div class="detail">
<p class="signature" id="!/1">
- <strong>!(arg)</strong>
+ <strong>!arg</strong>
</p>
<div class="docstring"><p>It receives any argument and returns true if it is false
or nil. Returns false otherwise. Not allowed in guard
@@ -1755,7 +1755,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L168" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="!=/2">
- <strong>!=(left, right)</strong>
+ <strong>left != right</strong>
</p>
<div class="docstring"><p>Returns true if the two items are not equal.</p>
@@ -1775,7 +1775,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L253" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="!==/2">
- <strong>!==(left, right)</strong>
+ <strong>left !== right</strong>
</p>
<div class="docstring"><p>Returns true if the two items are strictly not equal.
As Erlang, Elixir can compare any term. Allowed in guard clauses.</p>
@@ -1792,7 +1792,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L283" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&amp;&amp;/2">
- <strong>&amp;&amp;(left, right)</strong>
+ <strong>left &amp;&amp; right</strong>
</p>
<div class="docstring"><p>Provides a short-circuit operator that executes the second
expression only if the first one evalutes to true (i.e. it is
@@ -1813,7 +1813,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L2595" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="*/2">
- <strong>*(left, right)</strong>
+ <strong>left * right</strong>
</p>
<div class="docstring"><p>Arithmetic multiplication. Allowed in guard clauses.</p>
@@ -1825,7 +1825,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L50" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="+/2">
- <strong>+(left, right)</strong>
+ <strong>left + right</strong>
</p>
<div class="docstring"><p>Arithmetic plus. Allowed in guard clauses.</p>
@@ -1837,7 +1837,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L30" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="++/2">
- <strong>++(left, right)</strong>
+ <strong>left ++ right</strong>
</p>
<div class="docstring"><p>Concatenates two lists. Allowed in guard clauses.</p>
@@ -1853,7 +1853,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L90" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="-/2">
- <strong>-(left, right)</strong>
+ <strong>left - right</strong>
</p>
<div class="docstring"><p>Arithmetic minus. Allowed in guard clauses.</p>
@@ -1865,7 +1865,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L40" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="--/2">
- <strong>--(left, right)</strong>
+ <strong>left -- right</strong>
</p>
<div class="docstring"><p>Removes the first occorrence of an item on the left
for each item on the right. Allowed in guard clauses.</p>
@@ -1882,7 +1882,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L105" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="../2">
- <strong>..(first, last)</strong>
+ <strong>first .. last</strong>
</p>
<div class="docstring"><p>Returns a range with the specified start and end.
Includes both ends.</p>
@@ -1898,7 +1898,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L2575" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="//2">
- <strong>/(left, right)</strong>
+ <strong>left / right</strong>
</p>
<div class="docstring"><p>Arithmetic division. Differently from other languages,
the result is always a float. Use div and rem if you want
@@ -1913,7 +1913,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L63" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="/&gt;/2">
- <strong>/&gt;(left, right)</strong>
+ <strong>left /&gt; right</strong>
</p>
<div class="docstring"><p><code>/&gt;</code> is called the pipeline operator as it is useful
to write pipeline style expressions. This operator
@@ -1952,7 +1952,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L2717" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&lt;/2">
- <strong>&lt;(left, right)</strong>
+ <strong>left &lt; right</strong>
</p>
<div class="docstring"><p>Return true if left is less than right.
As Erlang, Elixir can compare any term. Allowed in guard clauses.</p>
@@ -1966,7 +1966,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L180" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&lt;-/2">
- <strong>&lt;-(pid, msg)</strong>
+ <strong>pid &lt;- msg</strong>
</p>
<div class="docstring"><p>Sends a message to the process identified on the left.
A process can be identified bu its PID or, if it is registered,
@@ -1981,7 +1981,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L76" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&lt;=/2">
- <strong>&lt;=(left, right)</strong>
+ <strong>left &lt;= right</strong>
</p>
<div class="docstring"><p>Return true if left is less than or equal to right.
As Erlang, Elixir can compare any term. Allowed in guard clauses.</p>
@@ -1995,7 +1995,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L204" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&lt;&gt;/2">
- <strong>&lt;&gt;(left, right)</strong>
+ <strong>left &lt;&gt; right</strong>
</p>
<div class="docstring"><p>Concatenates two binaries.</p>
@@ -2014,7 +2014,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L2558" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="==/2">
- <strong>==(left, right)</strong>
+ <strong>left == right</strong>
</p>
<div class="docstring"><p>Returns true if the two items are equal.</p>
@@ -2035,7 +2035,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L235" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="===/2">
- <strong>===(left, right)</strong>
+ <strong>left === right</strong>
</p>
<div class="docstring"><p>Returns true if the two items are strictly equal.
As Erlang, Elixir can compare any term. Allowed in guard clauses.</p>
@@ -2052,7 +2052,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L268" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="=~/2">
- <strong>=~(left, right)</strong>
+ <strong>left =~ right</strong>
</p>
<div class="docstring"><p>Matches the term on the left against the regular expression
on the right. It returns nil if not match happened or the
@@ -2067,7 +2067,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L2680" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&gt;/2">
- <strong>&gt;(left, right)</strong>
+ <strong>left &gt; right</strong>
</p>
<div class="docstring"><p>Return true if left is more than right.
As Erlang, Elixir can compare any term. Allowed in guard clauses.</p>
@@ -2081,7 +2081,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L192" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&gt;=/2">
- <strong>&gt;=(left, right)</strong>
+ <strong>left &gt;= right</strong>
</p>
<div class="docstring"><p>Return true if left is more than or equal to right.
As Erlang, Elixir can compare any term. Allowed in guard clauses.</p>
@@ -2095,7 +2095,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L216" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="@/1">
- <strong>@(expr)</strong>
+ <strong>@expr</strong>
</p>
<div class="docstring"><p>This macro is a shortcut to read and add attributes to the module
being compiled. Elixir module attributes are similar to Erlang&#39;s with
@@ -2298,7 +2298,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L2897" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="and/2">
- <strong>and(left, right)</strong>
+ <strong>left and right</strong>
</p>
<div class="docstring"><p>Boolean and. Arguments needs to necessarily be booleans.
Allowed in guard clauses.</p>
@@ -3227,7 +3227,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L2302" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="in/2">
- <strong>in(left, right)</strong>
+ <strong>left in right</strong>
</p>
<div class="docstring"><p>Returns true if the element on the left is equal (==) to
any of the items in the right. For now, it only accepts
@@ -3404,7 +3404,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L1907" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="not/1">
- <strong>not(arg)</strong>
+ <strong>not arg</strong>
</p>
<div class="docstring"><p>Boolean not. Argument needs to necessarily be a boolean.
Allowed in guard clauses.</p>
@@ -3418,7 +3418,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L153" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="or/2">
- <strong>or(left, right)</strong>
+ <strong>left or right</strong>
</p>
<div class="docstring"><p>Boolean or. Arguments needs to necessarily be booleans.
Allowed in guard clauses.</p>
@@ -3709,7 +3709,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L290" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="xor/2">
- <strong>xor(left, right)</strong>
+ <strong>left xor right</strong>
</p>
<div class="docstring"><p>Boolean xor. Arguments needs to necessarily be booleans.
Allowed in guard clauses.</p>
@@ -3723,7 +3723,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L141" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="||/2">
- <strong>||(left, right)</strong>
+ <strong>left || right</strong>
</p>
<div class="docstring"><p>Provides a short-circuit operator that executes the second
expression only if the first one does not evalute to true (i.e. it
View
149 docs/master/Mix.SCM.html
@@ -66,6 +66,56 @@
+ <h2>Callbacks summary</h2>
+ <ul class="summary">
+ <li>
+ <span class="summary_signature">
+ <a href="#clean/1">clean/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#equals?/2">equals?/2</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#matches_lock?/1">matches_lock?/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#update/1">update/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#checkout/1">checkout/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#checked_out?/1">checked_out?/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#accepts_options/1">accepts_options/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#format_lock/1">format_lock/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#format/1">format/1</a>
+ </span>
+</li>
+
+ </ul>
+
<div id="functions_details" class="details_list">
@@ -98,6 +148,105 @@
+ <div id="callbacks_details" class="details_list">
+ <h2>Callbacks</h2>
+ <div class="detail">
+ <p class="signature" id="clean/1">
+ <strong>clean(opts())</strong>
+ </p>
+ <div class="docstring"><p>This behavior function should clean the given dependency.</p>
+</div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/mix/lib/mix/scm.ex#L85" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="equals?/2">
+ <strong>equals?(opts1 :: opts(), opts2 :: opts())</strong>
+ </p>
+ <div class="docstring"><p>Receives two options and must return true if the refer to the
+same repository. The options are guaranteed to belong to the
+same SCM.</p>
+</div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/mix/lib/mix/scm.ex#L80" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="matches_lock?/1">
+ <strong>matches_lock?(opts())</strong>
+ </p>
+ <div class="docstring"><p>This behavior function checks if the dependency is locked and
+the current repository version matches the lock. Note that some
+SCMs do not require a lock, for such, this function can simply
+return true.</p>
+</div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/mix/lib/mix/scm.ex#L73" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="update/1">
+ <strong>update(opts())</strong>
+ </p>
+ <div class="docstring"><p>This behavior function updates dependencies. It may be
+called by <code>deps.get</code> or <code>deps.update</code>.</p>
+
+<p>In the first scenario, a lock is received in <code>opts</code> and
+the repository must be updated to the lock. In the second,
+no lock is given and the repository can be updated freely.</p>
+
+<p>It must return the current lock.</p>
+</div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/mix/lib/mix/scm.ex#L65" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="checkout/1">
+ <strong>checkout(opts())</strong>
+ </p>
+ <div class="docstring"><p>This behavior function checks out dependencies.</p>
+
+<p>If the dependency is locked, a lock is received in <code>opts</code>
+and the repository must be check out at the lock. Otherwise,
+no lock is given and the repository can be checked out
+to the latest version.</p>
+</div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/mix/lib/mix/scm.ex#L53" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="checked_out?/1">
+ <strong>checked_out?(opts())</strong>
+ </p>
+ <div class="docstring"><p>This behavior function returns a boolean if the
+dependency is available.</p>
+</div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/mix/lib/mix/scm.ex#L43" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="accepts_options/1">
+ <strong>accepts_options(opts())</strong>
+ </p>
+ <div class="docstring"><p>This behavior function receives a keyword list of <code>opts</code>
+and should return an updated list in case the SCM consumes
+the available options. For example, when a developer specifies
+a dependency:</p>
+
+<pre><code>{ :foo, &quot;0.1.0&quot;, github: &quot;foo/bar&quot; }
+</code></pre>
+
+<p>Each registered SCM will be asked if they consume this dependency,
+receiving [github: &quot;foo/bar&quot;] as argument. Since this option makes
+sense for the Git SCM, it will return an update list of options
+while other SCMs would simply return nil.</p>
+</div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/mix/lib/mix/scm.ex#L37" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="format_lock/1">
+ <strong>format_lock(lock())</strong>
+ </p>
+ <div class="docstring"><p>Returns an Elixir term that contains relevant SCM
+lock information for printing.</p>
+</div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/mix/lib/mix/scm.ex#L22" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="format/1">
+ <strong>format(opts())</strong>
+ </p>
+ <div class="docstring"><p>Returns an Elixir term that contains relevant SCM
+information for printing.</p>
+</div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/mix/lib/mix/scm.ex#L16" target="_blank" class="view_source">Source</a>
+</div>
+ </div>
+
</div>
</body>
</html>
View
59 docs/master/Mix.Shell.html
@@ -55,6 +55,31 @@
+ <h2>Callbacks summary</h2>
+ <ul class="summary">
+ <li>
+ <span class="summary_signature">
+ <a href="#cmd/1">cmd/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#yes?/1">yes?/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#error/1">error/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#info/1">info/1</a>
+ </span>
+</li>
+
+ </ul>
+
<div id="functions_details" class="details_list">
@@ -74,6 +99,40 @@
+ <div id="callbacks_details" class="details_list">
+ <h2>Callbacks</h2>
+ <div class="detail">
+ <p class="signature" id="cmd/1">
+ <strong>cmd(command :: binary())</strong>
+ </p>
+ <div class="docstring"><p>Executes the given command and returns
+its exit status.</p>
+</div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/mix/lib/mix/shell.ex#L27" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="yes?/1">
+ <strong>yes?(message :: binary())</strong>
+ </p>
+ <div class="docstring"><p>Asks the user for confirmation.</p>
+</div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/mix/lib/mix/shell.ex#L21" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="error/1">
+ <strong>error(message :: binary())</strong>
+ </p>
+ <div class="docstring"><p>Warns about the given error message.</p>
+</div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/mix/lib/mix/shell.ex#L16" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="info/1">
+ <strong>info(message :: binary())</strong>
+ </p>
+ <div class="docstring"><p>Informs the given message.</p>
+</div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/mix/lib/mix/shell.ex#L11" target="_blank" class="view_source">Source</a>
+</div>
+ </div>
+
</div>
</body>
</html>
View
23 docs/master/Mix.Task.html
@@ -100,6 +100,16 @@
+ <h2>Callbacks summary</h2>
+ <ul class="summary">
+ <li>
+ <span class="summary_signature">
+ <a href="#run/1">run/1</a>
+ </span>
+</li>
+
+ </ul>
+
<div id="functions_details" class="details_list">
@@ -200,6 +210,19 @@
+ <div id="callbacks_details" class="details_list">
+ <h2>Callbacks</h2>
+ <div class="detail">
+ <p class="signature" id="run/1">
+ <strong>run(list(binary()))</strong>
+ </p>
+ <div class="docstring"><p>A task needs to implement run which receives
+a list of command line args.</p>
+</div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/mix/lib/mix/task.ex#L13" target="_blank" class="view_source">Source</a>
+</div>
+ </div>
+
</div>
</body>
</html>
View
34 docs/master/URI.Parser.html
@@ -46,12 +46,46 @@
+ <h2>Callbacks summary</h2>
+ <ul class="summary">
+ <li>
+ <span class="summary_signature">
+ <a href="#default_port/0">default_port/0</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#parse/1">parse/1</a>
+ </span>
+</li>
+ </ul>
+
+
+ <div id="callbacks_details" class="details_list">
+ <h2>Callbacks</h2>
+ <div class="detail">
+ <p class="signature" id="default_port/0">
+ <strong>default_port()</strong>
+ </p>
+ <div class="docstring"><p>Responsible for returning the default port.</p>
+</div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/uri/parser.ex#L17" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="parse/1">
+ <strong>parse(uri_info :: URI.Info.t())</strong>
+ </p>
+ <div class="docstring"><p>Responsible for parsing extra URL information.</p>
+</div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/uri/parser.ex#L12" target="_blank" class="view_source">Source</a>
+</div>
+ </div>
+
</div>
</body>
</html>
View
231 docs/master/modules_list.html
@@ -432,6 +432,83 @@ <h1 id="full_list_header">
<li>
<span class="object_link">
+ <a href="Dict.html#values/1">values/1</a>
+ </span>
+ <small class="search_info">Dict</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Dict.html#update/3">update/3</a>
+ </span>
+ <small class="search_info">Dict</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Dict.html#to_list/1">to_list/1</a>
+ </span>
+ <small class="search_info">Dict</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Dict.html#size/1">size/1</a>
+ </span>
+ <small class="search_info">Dict</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Dict.html#put/3">put/3</a>
+ </span>
+ <small class="search_info">Dict</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Dict.html#merge/3">merge/3</a>
+ </span>
+ <small class="search_info">Dict</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Dict.html#keys/1">keys/1</a>
+ </span>
+ <small class="search_info">Dict</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Dict.html#has_key?/2">has_key?/2</a>
+ </span>
+ <small class="search_info">Dict</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Dict.html#get/3">get/3</a>
+ </span>
+ <small class="search_info">Dict</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Dict.html#empty/1">empty/1</a>
+ </span>
+ <small class="search_info">Dict</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Dict.html#delete/2">delete/2</a>
+ </span>
+ <small class="search_info">Dict</small>
+ </li>
+
+ <li>
+ <span class="object_link">
<a href="Dict.html#delete/2">delete/2</a>
</span>
<small class="search_info">Dict</small>
@@ -1122,6 +1199,48 @@ <h1 id="full_list_header">
<ul>
+ <li>
+ <span class="object_link">
+ <a href="ExUnit.Formatter.html#test_finished/3">test_finished/3</a>
+ </span>
+ <small class="search_info">ExUnit.Formatter</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="ExUnit.Formatter.html#test_started/2">test_started/2</a>
+ </span>
+ <small class="search_info">ExUnit.Formatter</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="ExUnit.Formatter.html#case_finished/1">case_finished/1</a>
+ </span>
+ <small class="search_info">ExUnit.Formatter</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="ExUnit.Formatter.html#case_started/1">case_started/1</a>
+ </span>
+ <small class="search_info">ExUnit.Formatter</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="ExUnit.Formatter.html#suite_finished/0">suite_finished/0</a>
+ </span>
+ <small class="search_info">ExUnit.Formatter</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="ExUnit.Formatter.html#suite_started/0">suite_started/0</a>
+ </span>
+ <small class="search_info">ExUnit.Formatter</small>
+ </li>
+
</ul>
@@ -3933,6 +4052,69 @@ <h1 id="full_list_header">
<li>
<span class="object_link">
+ <a href="Mix.SCM.html#clean/1">clean/1</a>
+ </span>
+ <small class="search_info">Mix.SCM</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Mix.SCM.html#equals?/2">equals?/2</a>
+ </span>
+ <small class="search_info">Mix.SCM</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Mix.SCM.html#matches_lock?/1">matches_lock?/1</a>
+ </span>
+ <small class="search_info">Mix.SCM</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Mix.SCM.html#update/1">update/1</a>
+ </span>
+ <small class="search_info">Mix.SCM</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Mix.SCM.html#checkout/1">checkout/1</a>
+ </span>
+ <small class="search_info">Mix.SCM</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Mix.SCM.html#checked_out?/1">checked_out?/1</a>
+ </span>
+ <small class="search_info">Mix.SCM</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Mix.SCM.html#accepts_options/1">accepts_options/1</a>
+ </span>
+ <small class="search_info">Mix.SCM</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Mix.SCM.html#format_lock/1">format_lock/1</a>
+ </span>
+ <small class="search_info">Mix.SCM</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Mix.SCM.html#format/1">format/1</a>
+ </span>
+ <small class="search_info">Mix.SCM</small>
+ </li>
+
+ <li>
+ <span class="object_link">
<a href="Mix.SCM.html#available/0">available/0</a>
</span>
<small class="search_info">Mix.SCM</small>
@@ -3965,6 +4147,34 @@ <h1 id="full_list_header">
<li>
<span class="object_link">
+ <a href="Mix.Shell.html#cmd/1">cmd/1</a>
+ </span>
+ <small class="search_info">Mix.Shell</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Mix.Shell.html#yes?/1">yes?/1</a>
+ </span>
+ <small class="search_info">Mix.Shell</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Mix.Shell.html#error/1">error/1</a>
+ </span>
+ <small class="search_info">Mix.Shell</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="Mix.Shell.html#info/1">info/1</a>
+ </span>
+ <small class="search_info">Mix.Shell</small>
+ </li>
+
+ <li>
+ <span class="object_link">
<a href="Mix.Shell.html#cmd/2">cmd/2</a>
</span>
<small class="search_info">Mix.Shell</small>
@@ -4068,6 +4278,13 @@ <h1 id="full_list_header">
<li>
<span class="object_link">
+ <a href="Mix.Task.html#run/1">run/1</a>
+ </span>
+ <small class="search_info">Mix.Task</small>
+ </li>
+
+ <li>
+ <span class="object_link">
<a href="Mix.Task.html#all_modules/0">all_modules/0</a>
</span>
<small class="search_info">Mix.Task</small>
@@ -5861,6 +6078,20 @@ <h1 id="full_list_header">
<ul>
+ <li>
+ <span class="object_link">
+ <a href="URI.Parser.html#default_port/0">default_port/0</a>
+ </span>
+ <small class="search_info">URI.Parser</small>
+ </li>
+
+ <li>
+ <span class="object_link">
+ <a href="URI.Parser.html#parse/1">parse/1</a>
+ </span>
+ <small class="search_info">URI.Parser</small>
+ </li>
+
</ul>
<li>
<a class="toggle"></a>
View
10 docs/stable/Bitwise.html
@@ -137,28 +137,28 @@
<h2>Macros</h2>
<div class="detail">
<p class="signature" id="&amp;&amp;&amp;/2">
- <strong>&amp;&amp;&amp;(left, right)</strong>
+ <strong>left &amp;&amp;&amp; right</strong>
</p>
<div class="docstring"><p>Bitwise and as operator.</p>
</div>
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/bitwise.ex#L67" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&lt;&lt;&lt;/2">
- <strong>&lt;&lt;&lt;(left, right)</strong>
+ <strong>left &lt;&lt;&lt; right</strong>
</p>
<div class="docstring"><p>Arithmetic bitshift left as operator.</p>
</div>
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/bitwise.ex#L109" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&gt;&gt;&gt;/2">
- <strong>&gt;&gt;&gt;(left, right)</strong>
+ <strong>left &gt;&gt;&gt; right</strong>
</p>
<div class="docstring"><p>Arithmetic bitshift right as operator.</p>
</div>
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/bitwise.ex#L123" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="^^^/2">
- <strong>^^^(left, right)</strong>
+ <strong>left ^^^ right</strong>
</p>
<div class="docstring"><p>Bitwise xor as operator.</p>
</div>
@@ -220,7 +220,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/bitwise.ex#L88" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="|||/2">
- <strong>|||(left, right)</strong>
+ <strong>left ||| right</strong>
</p>
<div class="docstring"><p>Bitwise or as operator.</p>
</div>
View
131 docs/stable/Dict.html
@@ -143,6 +143,66 @@
+ <h2>Callbacks summary</h2>
+ <ul class="summary">
+ <li>
+ <span class="summary_signature">
+ <a href="#values/1">values/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#update/3">update/3</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#to_list/1">to_list/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#size/1">size/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#put/3">put/3</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#merge/3">merge/3</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#keys/1">keys/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#has_key?/2">has_key?/2</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#get/3">get/3</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#empty/1">empty/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#delete/2">delete/2</a>
+ </span>
+</li>
+
+ </ul>
+
<div id="functions_details" class="details_list">
@@ -354,6 +414,77 @@
+ <div id="callbacks_details" class="details_list">
+ <h2>Callbacks</h2>
+ <div class="detail">
+ <p class="signature" id="values/1">
+ <strong>values(t())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L45" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="update/3">
+ <strong>update(t(), key(), (value() -&gt; value()))</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L44" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="to_list/1">
+ <strong>to_list(t())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L43" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="size/1">
+ <strong>size(t())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L42" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="put/3">
+ <strong>put(t(), key(), value())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L41" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="merge/3">
+ <strong>merge(t(), t(), (key(), value(), value() -&gt; value()))</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L40" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="keys/1">
+ <strong>keys(t())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L39" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="has_key?/2">
+ <strong>has_key?(t(), key())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L38" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="get/3">
+ <strong>get(t(), key(), value())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L37" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="empty/1">
+ <strong>empty(t())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L36" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="delete/2">
+ <strong>delete(t(), key())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/dict.ex#L35" target="_blank" class="view_source">Source</a>
+</div>
+ </div>
+
</div>
</body>
</html>
View
2 docs/stable/EEx.Engine.html
@@ -23,8 +23,6 @@
<h1>
EEx.Engine
- <small>behaviour</small>
-
</h1>
View
76 docs/stable/ExUnit.Formatter.html
@@ -46,12 +46,88 @@
+ <h2>Callbacks summary</h2>
+ <ul class="summary">
+ <li>
+ <span class="summary_signature">
+ <a href="#test_finished/3">test_finished/3</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#test_started/2">test_started/2</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#case_finished/1">case_finished/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#case_started/1">case_started/1</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#suite_finished/0">suite_finished/0</a>
+ </span>
+</li>
+<li>
+ <span class="summary_signature">
+ <a href="#suite_started/0">suite_started/0</a>
+ </span>
+</li>
+ </ul>
+
+
+ <div id="callbacks_details" class="details_list">
+ <h2>Callbacks</h2>
+ <div class="detail">
+ <p class="signature" id="test_finished/3">
+ <strong>test_finished(test_case(), test(), result())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/ex_unit/lib/ex_unit/formatter.ex#L20" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="test_started/2">
+ <strong>test_started(test_case(), test())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/ex_unit/lib/ex_unit/formatter.ex#L19" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="case_finished/1">
+ <strong>case_finished(test_case())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/ex_unit/lib/ex_unit/formatter.ex#L17" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="case_started/1">
+ <strong>case_started(test_case())</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/ex_unit/lib/ex_unit/formatter.ex#L16" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="suite_finished/0">
+ <strong>suite_finished()</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/ex_unit/lib/ex_unit/formatter.ex#L14" target="_blank" class="view_source">Source</a>
+</div><div class="detail">
+ <p class="signature" id="suite_started/0">
+ <strong>suite_started()</strong>
+ </p>
+ <div class="docstring"></div>
+ <a href="https://github.com/elixir-lang/elixir/blob/master/lib/ex_unit/lib/ex_unit/formatter.ex#L13" target="_blank" class="view_source">Source</a>
+</div>
+ </div>
+
</div>
</body>
</html>
View
10 docs/stable/Kernel.SpecialForms.html
@@ -153,7 +153,7 @@
<h2>Macros</h2>
<div class="detail">
<p class="signature" id="&lt;&lt;&gt;&gt;/1">
- <strong>&lt;&lt;&gt;&gt;(args)</strong>
+ <strong>&lt;&lt;args&gt;&gt;</strong>
</p>
<div class="docstring"><p>Defines a new bitstring.</p>
@@ -166,7 +166,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel/special_forms.ex#L46" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="[]/1">
- <strong>[](args)</strong>
+ <strong>[args]</strong>
</p>
<div class="docstring"><p>Defines a new list.</p>
@@ -206,7 +206,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel/special_forms.ex#L197" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="__aliases__/1">
- <strong>__aliases__(args)</strong>
+ <strong>args</strong>
</p>
<div class="docstring"><p>This is the special form used to hold aliases information.
It is usually compiled to an atom:</p>
@@ -249,7 +249,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel/special_forms.ex#L485" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="__block__/1">
- <strong>__block__(args)</strong>
+ <strong>args</strong>
</p>
<div class="docstring"><p>This is the special form used whenever we have a block
of expressions in Elixir. This special form is private
@@ -677,7 +677,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel/special_forms.ex#L368" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="{}/1">
- <strong>{}(args)</strong>
+ <strong>{args}</strong>
</p>
<div class="docstring"><p>Defines a new tuple.</p>
View
56 docs/stable/Kernel.html
@@ -1738,7 +1738,7 @@
<h2>Macros</h2>
<div class="detail">
<p class="signature" id="!/1">
- <strong>!(arg)</strong>
+ <strong>!arg</strong>
</p>
<div class="docstring"><p>It receives any argument and returns true if it is false
or nil. Returns false otherwise. Not allowed in guard
@@ -1755,7 +1755,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L168" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="!=/2">
- <strong>!=(left, right)</strong>
+ <strong>left != right</strong>
</p>
<div class="docstring"><p>Returns true if the two items are not equal.</p>
@@ -1775,7 +1775,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L253" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="!==/2">
- <strong>!==(left, right)</strong>
+ <strong>left !== right</strong>
</p>
<div class="docstring"><p>Returns true if the two items are strictly not equal.
As Erlang, Elixir can compare any term. Allowed in guard clauses.</p>
@@ -1792,7 +1792,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L283" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&amp;&amp;/2">
- <strong>&amp;&amp;(left, right)</strong>
+ <strong>left &amp;&amp; right</strong>
</p>
<div class="docstring"><p>Provides a short-circuit operator that executes the second
expression only if the first one evalutes to true (i.e. it is
@@ -1813,7 +1813,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L2595" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="*/2">
- <strong>*(left, right)</strong>
+ <strong>left * right</strong>
</p>
<div class="docstring"><p>Arithmetic multiplication. Allowed in guard clauses.</p>
@@ -1825,7 +1825,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L50" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="+/2">
- <strong>+(left, right)</strong>
+ <strong>left + right</strong>
</p>
<div class="docstring"><p>Arithmetic plus. Allowed in guard clauses.</p>
@@ -1837,7 +1837,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L30" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="++/2">
- <strong>++(left, right)</strong>
+ <strong>left ++ right</strong>
</p>
<div class="docstring"><p>Concatenates two lists. Allowed in guard clauses.</p>
@@ -1853,7 +1853,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L90" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="-/2">
- <strong>-(left, right)</strong>
+ <strong>left - right</strong>
</p>
<div class="docstring"><p>Arithmetic minus. Allowed in guard clauses.</p>
@@ -1865,7 +1865,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L40" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="--/2">
- <strong>--(left, right)</strong>
+ <strong>left -- right</strong>
</p>
<div class="docstring"><p>Removes the first occorrence of an item on the left
for each item on the right. Allowed in guard clauses.</p>
@@ -1882,7 +1882,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L105" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="../2">
- <strong>..(first, last)</strong>
+ <strong>first .. last</strong>
</p>
<div class="docstring"><p>Returns a range with the specified start and end.
Includes both ends.</p>
@@ -1898,7 +1898,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L2575" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="//2">
- <strong>/(left, right)</strong>
+ <strong>left / right</strong>
</p>
<div class="docstring"><p>Arithmetic division. Differently from other languages,
the result is always a float. Use div and rem if you want
@@ -1913,7 +1913,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L63" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="/&gt;/2">
- <strong>/&gt;(left, right)</strong>
+ <strong>left /&gt; right</strong>
</p>
<div class="docstring"><p><code>/&gt;</code> is called the pipeline operator as it is useful
to write pipeline style expressions. This operator
@@ -1952,7 +1952,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L2717" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&lt;/2">
- <strong>&lt;(left, right)</strong>
+ <strong>left &lt; right</strong>
</p>
<div class="docstring"><p>Return true if left is less than right.
As Erlang, Elixir can compare any term. Allowed in guard clauses.</p>
@@ -1966,7 +1966,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L180" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&lt;-/2">
- <strong>&lt;-(pid, msg)</strong>
+ <strong>pid &lt;- msg</strong>
</p>
<div class="docstring"><p>Sends a message to the process identified on the left.
A process can be identified bu its PID or, if it is registered,
@@ -1981,7 +1981,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L76" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&lt;=/2">
- <strong>&lt;=(left, right)</strong>
+ <strong>left &lt;= right</strong>
</p>
<div class="docstring"><p>Return true if left is less than or equal to right.
As Erlang, Elixir can compare any term. Allowed in guard clauses.</p>
@@ -1995,7 +1995,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L204" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&lt;&gt;/2">
- <strong>&lt;&gt;(left, right)</strong>
+ <strong>left &lt;&gt; right</strong>
</p>
<div class="docstring"><p>Concatenates two binaries.</p>
@@ -2014,7 +2014,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L2558" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="==/2">
- <strong>==(left, right)</strong>
+ <strong>left == right</strong>
</p>
<div class="docstring"><p>Returns true if the two items are equal.</p>
@@ -2035,7 +2035,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L235" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="===/2">
- <strong>===(left, right)</strong>
+ <strong>left === right</strong>
</p>
<div class="docstring"><p>Returns true if the two items are strictly equal.
As Erlang, Elixir can compare any term. Allowed in guard clauses.</p>
@@ -2052,7 +2052,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L268" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="=~/2">
- <strong>=~(left, right)</strong>
+ <strong>left =~ right</strong>
</p>
<div class="docstring"><p>Matches the term on the left against the regular expression
on the right. It returns nil if not match happened or the
@@ -2067,7 +2067,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L2680" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&gt;/2">
- <strong>&gt;(left, right)</strong>
+ <strong>left &gt; right</strong>
</p>
<div class="docstring"><p>Return true if left is more than right.
As Erlang, Elixir can compare any term. Allowed in guard clauses.</p>
@@ -2081,7 +2081,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L192" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="&gt;=/2">
- <strong>&gt;=(left, right)</strong>
+ <strong>left &gt;= right</strong>
</p>
<div class="docstring"><p>Return true if left is more than or equal to right.
As Erlang, Elixir can compare any term. Allowed in guard clauses.</p>
@@ -2095,7 +2095,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L216" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="@/1">
- <strong>@(expr)</strong>
+ <strong>@expr</strong>
</p>
<div class="docstring"><p>This macro is a shortcut to read and add attributes to the module
being compiled. Elixir module attributes are similar to Erlang&#39;s with
@@ -2298,7 +2298,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L2897" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="and/2">
- <strong>and(left, right)</strong>
+ <strong>left and right</strong>
</p>
<div class="docstring"><p>Boolean and. Arguments needs to necessarily be booleans.
Allowed in guard clauses.</p>
@@ -3227,7 +3227,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L2302" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="in/2">
- <strong>in(left, right)</strong>
+ <strong>left in right</strong>
</p>
<div class="docstring"><p>Returns true if the element on the left is equal (==) to
any of the items in the right. For now, it only accepts
@@ -3404,7 +3404,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L1907" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="not/1">
- <strong>not(arg)</strong>
+ <strong>not arg</strong>
</p>
<div class="docstring"><p>Boolean not. Argument needs to necessarily be a boolean.
Allowed in guard clauses.</p>
@@ -3418,7 +3418,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L153" target="_blank" class="view_source">Source</a>
</div><div class="detail">
<p class="signature" id="or/2">
- <strong>or(left, right)</strong>
+ <strong>left or right</strong>
</p>
<div class="docstring"><p>Boolean or. Arguments needs to necessarily be booleans.
Allowed in guard clauses.</p>
@@ -3709,7 +3709,7 @@
<a href="https://github.com/elixir-lang/elixir/blob/master/lib/elixir/lib/kernel.ex#L290" target="_blank" class="view_source">Source</a>