Skip to content

Commit 859c434

Browse files
committed
1 parent 390c52f commit 859c434

File tree

119 files changed

+343
-335
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

119 files changed

+343
-335
lines changed

.build

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ dist/merriweather-latin-ext-300-normal-K6L27CZ5.woff2
137137
dist/merriweather-vietnamese-300-italic-EHHNZPUO.woff2
138138
dist/merriweather-vietnamese-300-normal-U376L4Z4.woff2
139139
dist/remixicon-NKANDIL5.woff2
140-
dist/search_items-F09F914E.js
141-
dist/sidebar_items-F59AA3AC.js
140+
dist/search_items-5CC7A60B.js
141+
dist/sidebar_items-EA60E5D0.js
142142
index.html
143143
search.html

404.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
1515
<script src="dist/handlebars.templates-XWGFFSCD.js"></script>
16-
<script src="dist/sidebar_items-F59AA3AC.js"></script>
16+
<script src="dist/sidebar_items-EA60E5D0.js"></script>
1717

1818
<script src="docs_config.js"></script>
1919

EpochtalkServer.Auth.Guardian.Plug.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
1515
<script src="dist/handlebars.templates-XWGFFSCD.js"></script>
16-
<script src="dist/sidebar_items-F59AA3AC.js"></script>
16+
<script src="dist/sidebar_items-EA60E5D0.js"></script>
1717

1818
<script src="docs_config.js"></script>
1919

@@ -478,11 +478,11 @@ <h1 class="signature" translate="no">remember_me_from_token(conn, token, claims
478478
<div class="specs">
479479

480480
<pre translate="no"><span class="attribute">@spec</span> remember_me_from_token(
481-
<a href="https://hexdocs.pm/plug/1.16.0/Plug.Conn.html#t:t/0">Plug.Conn.t</a>(),
481+
<a href="https://hexdocs.pm/plug/1.16.1/Plug.Conn.html#t:t/0">Plug.Conn.t</a>(),
482482
<a href="https://hexdocs.pm/guardian/2.3.2/Guardian.Token.html#t:token/0">Guardian.Token.token</a>(),
483483
<a href="https://hexdocs.pm/guardian/2.3.2/Guardian.Token.html#t:claims/0">Guardian.Token.claims</a>(),
484484
<a href="https://hexdocs.pm/guardian/2.3.2/Guardian.html#t:options/0">Guardian.options</a>()
485-
) :: <a href="https://hexdocs.pm/plug/1.16.0/Plug.Conn.html#t:t/0">Plug.Conn.t</a>()</pre>
485+
) :: <a href="https://hexdocs.pm/plug/1.16.1/Plug.Conn.html#t:t/0">Plug.Conn.t</a>()</pre>
486486

487487
</div>
488488

EpochtalkServer.Auth.Guardian.html

Lines changed: 17 additions & 17 deletions
Large diffs are not rendered by default.

EpochtalkServer.Cache.Role.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
1515
<script src="dist/handlebars.templates-XWGFFSCD.js"></script>
16-
<script src="dist/sidebar_items-F59AA3AC.js"></script>
16+
<script src="dist/sidebar_items-EA60E5D0.js"></script>
1717

1818
<script src="docs_config.js"></script>
1919

EpochtalkServer.Mailer.html

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
1515
<script src="dist/handlebars.templates-XWGFFSCD.js"></script>
16-
<script src="dist/sidebar_items-F59AA3AC.js"></script>
16+
<script src="dist/sidebar_items-EA60E5D0.js"></script>
1717

1818
<script src="docs_config.js"></script>
1919

@@ -126,6 +126,8 @@ <h2>
126126

127127
</div>
128128

129+
<div class="summary-synopsis"><p>Delivers an email.</p></div>
130+
129131
</div>
130132

131133
<div class="summary-row">
@@ -134,6 +136,8 @@ <h2>
134136

135137
</div>
136138

139+
<div class="summary-synopsis"><p>Delivers an email, raises on error.</p></div>
140+
137141
</div>
138142

139143
<div class="summary-row">
@@ -142,6 +146,8 @@ <h2>
142146

143147
</div>
144148

149+
<div class="summary-synopsis"><p>Delivers a list of emails.</p></div>
150+
145151
</div>
146152

147153
<div class="summary-row">
@@ -216,11 +222,12 @@ <h1 class="signature" translate="no">deliver(email, config \\ [])</h1>
216222

217223
<div class="specs">
218224

219-
<pre translate="no"><span class="attribute">@spec</span> deliver(<a href="https://hexdocs.pm/swoosh/1.16.7/Swoosh.Email.html#t:t/0">Swoosh.Email.t</a>(), <a href="https://hexdocs.pm/elixir/Keyword.html#t:t/0">Keyword.t</a>()) :: {:ok, <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()} | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()}</pre>
225+
<pre translate="no"><span class="attribute">@spec</span> deliver(<a href="https://hexdocs.pm/swoosh/1.17.3/Swoosh.Email.html#t:t/0">Swoosh.Email.t</a>(), <a href="https://hexdocs.pm/elixir/Keyword.html#t:t/0">Keyword.t</a>()) :: {:ok, <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()} | {:error, <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()}</pre>
220226

221227
</div>
222228

223-
229+
<p>Delivers an email.</p><p>If the email is delivered it returns an <code class="inline">{:ok, result}</code> tuple. If it fails,
230+
returns an <code class="inline">{:error, error}</code> tuple.</p>
224231
</section>
225232
</section>
226233
<section class="detail" id="deliver!/2">
@@ -241,11 +248,12 @@ <h1 class="signature" translate="no">deliver!(email, config \\ [])</h1>
241248

242249
<div class="specs">
243250

244-
<pre translate="no"><span class="attribute">@spec</span> deliver!(<a href="https://hexdocs.pm/swoosh/1.16.7/Swoosh.Email.html#t:t/0">Swoosh.Email.t</a>(), <a href="https://hexdocs.pm/elixir/Keyword.html#t:t/0">Keyword.t</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
251+
<pre translate="no"><span class="attribute">@spec</span> deliver!(<a href="https://hexdocs.pm/swoosh/1.17.3/Swoosh.Email.html#t:t/0">Swoosh.Email.t</a>(), <a href="https://hexdocs.pm/elixir/Keyword.html#t:t/0">Keyword.t</a>()) :: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>() | <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">no_return</a>()</pre>
245252

246253
</div>
247254

248-
255+
<p>Delivers an email, raises on error.</p><p>If the email is delivered, it returns the result. If it fails, it raises
256+
a <code class="inline">DeliveryError</code>.</p>
249257
</section>
250258
</section>
251259
<section class="detail" id="deliver_many/2">
@@ -289,7 +297,7 @@ <h1 class="signature" translate="no">deliver_many(emails, config \\ [])</h1>
289297

290298
</div>
291299

292-
300+
<p>Delivers a list of emails.</p><p>It accepts a list of <code class="inline">%Swoosh.Email{}</code> as its first parameter.</p>
293301
</section>
294302
</section>
295303
<section class="detail" id="send_confirm_account/1">

EpochtalkServer.Models.AutoModeration.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
1515
<script src="dist/handlebars.templates-XWGFFSCD.js"></script>
16-
<script src="dist/sidebar_items-F59AA3AC.js"></script>
16+
<script src="dist/sidebar_items-EA60E5D0.js"></script>
1717

1818
<script src="docs_config.js"></script>
1919

@@ -365,7 +365,7 @@ <h1 class="signature" translate="no">moderate(user, post_attrs)</h1>
365365
</a>
366366
Rule Anatomy
367367
</h3>
368-
<ul><li>Only works on posts</li><li>= Name: Name for this rule (for admin readability)</li><li>= Description: What this rule does (for admin readbility)</li><li>= Message: Error reported back to the user on reject action</li><li>= Conditions: condition regex will only work on</li><li><ul><li>body</li></ul></li><li><ul><li>thread_id</li></ul></li><li><ul><li>user_id</li></ul></li><li><ul><li>title (although it's not much use)</li></ul></li><li> == REGEX IS AN OBJECT with a pattern and flag property</li><li> Multiple conditions are allow but they all must pass to enable rule actions</li><li>= Actions: reject, ban, edit, delete (filter not yet implemented)</li><li>= Options:</li><li><ul><li>banInterval:</li></ul></li><li><pre><code class="makeup elixir" translate="no"><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="nc">Affects</span><span class="w"> </span><span class="n">ban</span><span class="w"> </span><span class="n">action</span><span class="o">.</span></code></pre></li><li><pre><code class="makeup elixir" translate="no"><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="nc">Leave</span><span class="w"> </span><span class="n">blank</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">permanent</span></code></pre></li><li><pre><code class="makeup elixir" translate="no"><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="nc">Otherwise</span><span class="p">,</span><span class="w"> </span><span class="nc">JS</span><span class="w"> </span><span class="n">date</span><span class="w"> </span><span class="n">string</span></code></pre></li><li><ul><li>edit:</li></ul></li><li><pre><code class="makeup elixir" translate="no"><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="n">replace</span><span class="w"> </span><span class="p" data-group-id="4742300564-1">(</span><span class="n">replace</span><span class="w"> </span><span class="n">chunks</span><span class="w"> </span><span class="n">of</span><span class="w"> </span><span class="n">text</span><span class="p" data-group-id="4742300564-1">)</span><span class="p">:</span></code></pre></li><li><pre><code class="makeup elixir" translate="no"><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="ss">regex</span><span class="p">:</span><span class="w"> </span><span class="nc">Regex</span><span class="w"> </span><span class="n">used</span><span class="w"> </span><span class="n">to</span><span class="w"> </span><span class="n">match</span><span class="w"> </span><span class="n">post</span><span class="w"> </span><span class="n">body</span></code></pre></li><li><pre><code class="makeup elixir" translate="no"><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="n">regex</span><span class="w"> </span><span class="n">object</span><span class="w"> </span><span class="n">has</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">pattern</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="n">flag</span><span class="w"> </span><span class="n">property</span></code></pre></li><li><pre><code class="makeup elixir" translate="no"><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="ss">text</span><span class="p">:</span><span class="w"> </span><span class="nc">Text</span><span class="w"> </span><span class="n">used</span><span class="w"> </span><span class="n">to</span><span class="w"> </span><span class="n">replace</span><span class="w"> </span><span class="n">any</span><span class="w"> </span><span class="n">matches</span></code></pre></li><li><pre><code class="makeup elixir" translate="no"><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="ss">template</span><span class="p">:</span><span class="w"> </span><span class="nc">String</span><span class="w"> </span><span class="n">template</span><span class="w"> </span><span class="n">used</span><span class="w"> </span><span class="n">to</span><span class="w"> </span><span class="n">add</span><span class="w"> </span><span class="n">text</span><span class="w"> </span><span class="n">above</span><span class="w"> </span><span class="ow">or</span><span class="w"> </span><span class="n">below</span><span class="w"> </span><span class="n">post</span><span class="w"> </span><span class="n">body</span></code></pre></li></ul>
368+
<ul><li>Only works on posts</li><li>= Name: Name for this rule (for admin readability)</li><li>= Description: What this rule does (for admin readbility)</li><li>= Message: Error reported back to the user on reject action</li><li>= Conditions: condition regex will only work on</li><li><ul><li>body</li></ul></li><li><ul><li>thread_id</li></ul></li><li><ul><li>user_id</li></ul></li><li><ul><li>title (although it's not much use)</li></ul></li><li> == REGEX IS AN OBJECT with a pattern and flag property</li><li> Multiple conditions are allow but they all must pass to enable rule actions</li><li>= Actions: reject, ban, edit, delete (filter not yet implemented)</li><li>= Options:</li><li><ul><li>banInterval:</li></ul></li><li><pre><code class="makeup elixir" translate="no"><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="nc">Affects</span><span class="w"> </span><span class="n">ban</span><span class="w"> </span><span class="n">action</span><span class="o">.</span></code></pre></li><li><pre><code class="makeup elixir" translate="no"><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="nc">Leave</span><span class="w"> </span><span class="n">blank</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">permanent</span></code></pre></li><li><pre><code class="makeup elixir" translate="no"><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="nc">Otherwise</span><span class="p">,</span><span class="w"> </span><span class="nc">JS</span><span class="w"> </span><span class="n">date</span><span class="w"> </span><span class="n">string</span></code></pre></li><li><ul><li>edit:</li></ul></li><li><pre><code class="makeup elixir" translate="no"><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="n">replace</span><span class="w"> </span><span class="p" data-group-id="3620181947-1">(</span><span class="n">replace</span><span class="w"> </span><span class="n">chunks</span><span class="w"> </span><span class="n">of</span><span class="w"> </span><span class="n">text</span><span class="p" data-group-id="3620181947-1">)</span><span class="p">:</span></code></pre></li><li><pre><code class="makeup elixir" translate="no"><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="ss">regex</span><span class="p">:</span><span class="w"> </span><span class="nc">Regex</span><span class="w"> </span><span class="n">used</span><span class="w"> </span><span class="n">to</span><span class="w"> </span><span class="n">match</span><span class="w"> </span><span class="n">post</span><span class="w"> </span><span class="n">body</span></code></pre></li><li><pre><code class="makeup elixir" translate="no"><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="n">regex</span><span class="w"> </span><span class="n">object</span><span class="w"> </span><span class="n">has</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="n">pattern</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="n">flag</span><span class="w"> </span><span class="n">property</span></code></pre></li><li><pre><code class="makeup elixir" translate="no"><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="ss">text</span><span class="p">:</span><span class="w"> </span><span class="nc">Text</span><span class="w"> </span><span class="n">used</span><span class="w"> </span><span class="n">to</span><span class="w"> </span><span class="n">replace</span><span class="w"> </span><span class="n">any</span><span class="w"> </span><span class="n">matches</span></code></pre></li><li><pre><code class="makeup elixir" translate="no"><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="ss">template</span><span class="p">:</span><span class="w"> </span><span class="nc">String</span><span class="w"> </span><span class="n">template</span><span class="w"> </span><span class="n">used</span><span class="w"> </span><span class="n">to</span><span class="w"> </span><span class="n">add</span><span class="w"> </span><span class="n">text</span><span class="w"> </span><span class="n">above</span><span class="w"> </span><span class="ow">or</span><span class="w"> </span><span class="n">below</span><span class="w"> </span><span class="n">post</span><span class="w"> </span><span class="n">body</span></code></pre></li></ul>
369369
</section>
370370
</section>
371371
<section class="detail" id="remove/1">

EpochtalkServer.Models.Ban.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
1515
<script src="dist/handlebars.templates-XWGFFSCD.js"></script>
16-
<script src="dist/sidebar_items-F59AA3AC.js"></script>
16+
<script src="dist/sidebar_items-EA60E5D0.js"></script>
1717

1818
<script src="docs_config.js"></script>
1919

EpochtalkServer.Models.BannedAddress.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
1515
<script src="dist/handlebars.templates-XWGFFSCD.js"></script>
16-
<script src="dist/sidebar_items-F59AA3AC.js"></script>
16+
<script src="dist/sidebar_items-EA60E5D0.js"></script>
1717

1818
<script src="docs_config.js"></script>
1919

EpochtalkServer.Models.Board.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
<script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
1515
<script src="dist/handlebars.templates-XWGFFSCD.js"></script>
16-
<script src="dist/sidebar_items-F59AA3AC.js"></script>
16+
<script src="dist/sidebar_items-EA60E5D0.js"></script>
1717

1818
<script src="docs_config.js"></script>
1919

0 commit comments

Comments
 (0)