Skip to content

Commit

Permalink
Rebuild docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@lilyball
lilyball committed Jul 27, 2020
1 parent ac7e0d3 commit e141ba9
Show file tree
Hide file tree
Showing 36 changed files with 346 additions and 460 deletions.
4 changes: 2 additions & 2 deletions docs/Enums.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="Enumerations Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p><a href="index.html">Tomorrowland 1.4.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -309,7 +309,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-07-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Enums/NoError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="NoError Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Tomorrowland 1.4.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -274,7 +274,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-07-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Enums/PromiseCallbackError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="PromiseCallbackError Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Tomorrowland 1.4.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -160,7 +160,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-07-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Enums/PromiseContext.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="PromiseContext Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Tomorrowland 1.4.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -597,7 +597,7 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-07-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Enums/PromiseResult.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="PromiseResult Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Tomorrowland 1.4.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -700,7 +700,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-07-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Enums/PromiseTimeoutError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="PromiseTimeoutError Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Tomorrowland 1.4.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -395,7 +395,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-07-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Functions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="Functions Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p><a href="index.html">Tomorrowland 1.4.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -927,7 +927,7 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-07-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Structs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="Structures Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p><a href="index.html">Tomorrowland 1.4.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -347,7 +347,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-07-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Structs/DelayedPromise.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="DelayedPromise Structure Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Tomorrowland 1.4.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -304,7 +304,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-07-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
60 changes: 57 additions & 3 deletions docs/Structs/Promise.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="Promise Structure Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Tomorrowland 1.4.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -1681,7 +1681,8 @@ <h4>Return Value</h4>

<p>The returned <code>Promise</code> will always resolve with the same value that its receiver does, but
it won&rsquo;t affect the timing of any of the receiver&rsquo;s other observers and it won&rsquo;t affect
automatic cancellation propagation behavior.</p>
automatic cancellation propagation behavior. Requesting cancellation of the returned
<code>Promise</code> does nothing.</p>

<p><code>tap().always(on:token:_:)</code> behaves the same as <code><a href="../Structs/Promise.html#/s:12Tomorrowland7PromiseV3tap2on5token_ACyxq_GAA0B7ContextO_AA0B17InvalidationTokenVSgyAA0B6ResultOyxq_GctF">tap(on:token:_:)</a></code> except it returns a new
<code>Promise</code> whereas <code><a href="../Structs/Promise.html#/s:12Tomorrowland7PromiseV3tap2on5token_ACyxq_GAA0B7ContextO_AA0B17InvalidationTokenVSgyAA0B6ResultOyxq_GctF">tap(on:token:_:)</a></code> returns the receiver and can be inserted into any
Expand Down Expand Up @@ -1731,6 +1732,16 @@ <h4>Return Value</h4>
<div class="pointer"></div>
<div class="abstract">
<p>Registers a callback that will be invoked when the promise is cancelled.</p>
<div class="aside aside-note">
<p class="aside-title">Note</p>
<p>Like <code>tap</code>, <code>onCancel</code> does not prevent automatic cancellation propagation if the
parent has multiple children and all other children have requested cancellation. Unlike
<code>tap</code>, requesting cancellation of <code>onCancel</code> will cancel the parent if the parent has no
other children. <code>onCancel</code>&lsquo;s behavior differs from the other standard obsrevers here as
attaching an <code>onCancel</code> observer to a promise that would otherwise be cancelled should not
prevent the cancellation.</p>

</div>

</div>
<div class="declaration">
Expand Down Expand Up @@ -1824,6 +1835,13 @@ <h4>Return Value</h4>
<p>The intent of this method is to allow you to deduplicate requests for a long-lived resource
(such as a network load) without preventing cancellation of the load in the event that no
children care about it anymore.</p>
<div class="aside aside-important">
<p class="aside-title">Important</p>
<p>Do not give the returned promise directly to callers. Instead always hand back
a child, such as returned from <code>makeChild</code>. Otherwise automatic cancellation propagation
won&rsquo;t work as expected.</p>

</div>

</div>
<div class="declaration">
Expand Down Expand Up @@ -1887,6 +1905,42 @@ <h4>Return Value</h4>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:12Tomorrowland7PromiseV9makeChildACyxq_GyF"></a>
<a name="//apple_ref/swift/Method/makeChild()" class="dashAnchor"></a>
<a class="token" href="#/s:12Tomorrowland7PromiseV9makeChildACyxq_GyF">makeChild()</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Returns a promise that adopts the same value as the receiver.</p>

<p>This method is used in order to hand back child promises to callers so that they cannot
directly request cancellation of a shared parent promise. This is most useful in conjunction
with <code><a href="../Structs/Promise.html#/s:12Tomorrowland7PromiseV23propagatingCancellation2on15cancelRequestedACyxq_GAA0B7ContextO_yAGctF">propagatingCancellation(on:cancelRequested:)</a></code> but could also be used any time a shared
promise is given to multiple callers.</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">makeChild</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kt">Promise</span><span class="o">&lt;</span><span class="kt">Value</span><span class="p">,</span> <span class="kt">Error</span><span class="o">&gt;</span></code></pre>

</div>
</div>
<div>
<h4>Return Value</h4>
<p>A new promise that will resolve to the same value as the receiver.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -3390,7 +3444,7 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-07-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
9 changes: 5 additions & 4 deletions docs/Structs/Promise/Resolver.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="Resolver Structure Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../../index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p><a href="../../index.html">Tomorrowland 1.4.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="../../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -261,8 +261,9 @@ <h4>Declaration</h4>
Otherwise the receiver will wait until <code>promise</code> is resolved and resolve to the same
result.</p>

<p>If the receiver is cancelled, it will also propagate the cancellation to <code>promise</code>. If
this is not desired, then either use <code>resolve(with: promise.ignoringCancel())</code> or
<p>If the receiver is cancelled, it will also propagate the cancellation to <code>promise</code> the
same way that a child promise does. If this is not desired, then either use
<code>resolve(with: promise.ignoringCancel())</code> or
<code>promise.always(on: .immediate, resolver.resolve(with:))</code>.</p>

</div>
Expand Down Expand Up @@ -526,7 +527,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-07-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Structs/PromiseCancellable.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<a title="PromiseCancellable Structure Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Tomorrowland 1.3.0 Docs</a> (100% documented)</p>
<p><a href="../index.html">Tomorrowland 1.4.0 Docs</a> (100% documented)</p>
<p class="header-right"><a href="https://github.com/lilyball/Tomorrowland"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
Expand Down Expand Up @@ -166,7 +166,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-05-23)</p>
<p>&copy; 2020 <a class="link" href="https://github.com/lilyball/Tomorrowland" target="_blank" rel="external">Lily Ballard</a>. All rights reserved. (Last updated: 2020-07-26)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.3</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading

0 comments on commit e141ba9

Please sign in to comment.