diff options
author | Thijs Schreijer <thijs@thijsschreijer.nl> | 2024-03-05 21:18:24 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-03-05 23:18:24 +0300 |
commit | 23241717bf91c4317065828bedafd05ebb97c1ef (patch) | |
tree | 563d0854d4f3fdf7bab76a0ec5397a1c8cde0190 | |
parent | 98be8d9fc1de19ec526cf7bee0d03a1e78262ba8 (diff) | |
download | luasocket-23241717bf91c4317065828bedafd05ebb97c1ef.tar.gz luasocket-23241717bf91c4317065828bedafd05ebb97c1ef.tar.bz2 luasocket-23241717bf91c4317065828bedafd05ebb97c1ef.zip |
fix(docs): link to included LTN documents (#426)
-rw-r--r-- | docs/ltn12.html | 2 | ||||
-rw-r--r-- | docs/socket.html | 9 |
2 files changed, 10 insertions, 1 deletions
diff --git a/docs/ltn12.html b/docs/ltn12.html index fe3e3a0..30bc564 100644 --- a/docs/ltn12.html +++ b/docs/ltn12.html | |||
@@ -40,7 +40,7 @@ Pump, Support, Library"> | |||
40 | <h2 id="ltn12">LTN12</h2> | 40 | <h2 id="ltn12">LTN12</h2> |
41 | 41 | ||
42 | <p> The <tt>ltn12</tt> namespace implements the ideas described in | 42 | <p> The <tt>ltn12</tt> namespace implements the ideas described in |
43 | <a href="http://lua-users.org/wiki/FiltersSourcesAndSinks"> | 43 | <a href="https://github.com/lunarmodules/luasocket/blob/master/ltn012.md"> |
44 | LTN012, Filters sources and sinks</a>. This manual simply describes the | 44 | LTN012, Filters sources and sinks</a>. This manual simply describes the |
45 | functions. Please refer to the LTN for a deeper explanation of the | 45 | functions. Please refer to the LTN for a deeper explanation of the |
46 | functionality provided by this module. | 46 | functionality provided by this module. |
diff --git a/docs/socket.html b/docs/socket.html index c148114..b4db823 100644 --- a/docs/socket.html +++ b/docs/socket.html | |||
@@ -164,6 +164,9 @@ Creates and returns a <em>clean</em> | |||
164 | <a href="#try"><tt>try</tt></a> | 164 | <a href="#try"><tt>try</tt></a> |
165 | function that allows for cleanup before the exception | 165 | function that allows for cleanup before the exception |
166 | is raised. | 166 | is raised. |
167 | This implements the ideas described in | ||
168 | <a href="https://github.com/lunarmodules/luasocket/blob/master/ltn013.md"> | ||
169 | LTN012, Using finalized exceptions</a>. | ||
167 | </p> | 170 | </p> |
168 | 171 | ||
169 | <p class="parameters"> | 172 | <p class="parameters"> |
@@ -207,6 +210,9 @@ Converts a function that throws exceptions into a safe function. This | |||
207 | function only catches exceptions thrown by the <a href="#try"><tt>try</tt></a> | 210 | function only catches exceptions thrown by the <a href="#try"><tt>try</tt></a> |
208 | and <a href="#newtry"><tt>newtry</tt></a> functions. It does not catch normal | 211 | and <a href="#newtry"><tt>newtry</tt></a> functions. It does not catch normal |
209 | Lua errors. | 212 | Lua errors. |
213 | This implements the ideas described in | ||
214 | <a href="https://github.com/lunarmodules/luasocket/blob/master/ltn013.md"> | ||
215 | LTN012, Using finalized exceptions</a>. | ||
210 | </p> | 216 | </p> |
211 | 217 | ||
212 | <p class="parameters"> | 218 | <p class="parameters"> |
@@ -425,6 +431,9 @@ socket.<b>try(</b>ret<sub>1</sub> [, ret<sub>2</sub> ... ret<sub>N</sub>]<b>)</b | |||
425 | Throws an exception in case <tt>ret<sub>1</sub></tt> is falsy, using | 431 | Throws an exception in case <tt>ret<sub>1</sub></tt> is falsy, using |
426 | <tt>ret<sub>2</sub></tt> as the error message. The exception is supposed to be caught | 432 | <tt>ret<sub>2</sub></tt> as the error message. The exception is supposed to be caught |
427 | by a <a href="#protect"><tt>protect</tt></a>ed function only. | 433 | by a <a href="#protect"><tt>protect</tt></a>ed function only. |
434 | This implements the ideas described in | ||
435 | <a href="https://github.com/lunarmodules/luasocket/blob/master/ltn013.md"> | ||
436 | LTN012, Using finalized exceptions</a>. | ||
428 | </p> | 437 | </p> |
429 | 438 | ||
430 | <p class="parameters"> | 439 | <p class="parameters"> |