Skip to content

Commit 36867e6

Browse files
LewisJEllisLewisJEllis
committed
Update docs with verify_ssl and cacert config fields
1 parent 497da76 commit 36867e6

File tree

3 files changed

+61
-49
lines changed

3 files changed

+61
-49
lines changed

‎docs/index.html

+33-29
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
<div id="navigation">
2626
<br/>
27-
<h1>ldoc</h1>
27+
<h1>raven-lua</h1>
2828

2929

3030
<h2>Contents</h2>
@@ -34,7 +34,7 @@ <h2>Contents</h2>
3434

3535

3636
<h2>Modules</h2>
37-
<ul class="$(kind=='Topics' and '' or 'nowrap'">
37+
<ul class="nowrap">
3838
<li><strong>raven</strong></li>
3939
</ul>
4040

@@ -88,7 +88,8 @@ <h2><a href="#Functions">Functions</a></h2>
8888
<br/>
8989

9090

91-
<h2><a name="Functions"></a>Functions</h2>
91+
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
92+
9293
<dl class="function">
9394
<dt>
9495
<a name = "new"></a>
@@ -109,9 +110,15 @@ <h3>Parameters:</h3>
109110
<pre>http://pub:[email protected]:8080/sentry/proj-id</pre>
110111
</li>
111112
<li><span class="parameter">conf</span>
112-
client configuration. Conf should be a hash table. Possiable
113-
keys are: "tags", "logger". For example:
114-
<pre>{ tags = { foo = "bar", abc = "def" }, logger = "myLogger" }</pre>
113+
client configuration. Conf should be a hash table. Possible keys are:
114+
<ul>
115+
<li><span class="parameter">tags</span> extra tags to include on all reported errors</li>
116+
<li><span class="parameter">logger</span></li>
117+
<li><span class="parameter">verify_ssl</span> boolean of whether to perform SSL certificate verification</li>
118+
<li><span class="parameter">cacert</span> path to CA certificate bundle file (defaults to ./data/cacert.pem)</li>
119+
</ul>
120+
For example:
121+
<pre>{ tags = { foo = "bar", abc = "def" }, logger = "myLogger", verify_ssl = false }</pre>
115122
</li>
116123
</ul>
117124

@@ -125,10 +132,9 @@ <h3>Returns:</h3>
125132

126133
<h3>Usage:</h3>
127134
<ul>
128-
<pre class="example">
129-
<span class="keyword">local</span> raven = <span class="global">require</span> <span class="string">"raven"</span>
130-
<span class="keyword">local</span> rvn = raven:new(dsn, { tags = { foo = <span class="string">"bar"</span>, abc = <span class="string">"def"</span> },
131-
logger = <span class="string">"myLogger"</span> })</pre>
135+
<pre class="example"><span class="keyword">local</span> raven = <span class="global">require</span> <span class="string">"raven"</span>
136+
<span class="keyword">local</span> rvn = raven:new(dsn, { tags = { foo = <span class="string">"bar"</span>, abc = <span class="string">"def"</span> },
137+
logger = <span class="string">"myLogger"</span> })</pre>
132138
</ul>
133139

134140
</dd>
@@ -183,12 +189,11 @@ <h3>Returns:</h3>
183189

184190
<h3>Usage:</h3>
185191
<ul>
186-
<pre class="example">
187-
<span class="keyword">local</span> raven = <span class="global">require</span> <span class="string">"raven"</span>
188-
<span class="keyword">local</span> rvn = raven:new(dsn, { tags = { foo = <span class="string">"bar"</span>, abc = <span class="string">"def"</span> },
189-
logger = <span class="string">"myLogger"</span> })
190-
<span class="keyword">local</span> id, err = rvn:captureException(exception,
191-
{ tags = { foo = <span class="string">"bar"</span>, abc = <span class="string">"def"</span> }})</pre>
192+
<pre class="example"><span class="keyword">local</span> raven = <span class="global">require</span> <span class="string">"raven"</span>
193+
<span class="keyword">local</span> rvn = raven:new(dsn, { tags = { foo = <span class="string">"bar"</span>, abc = <span class="string">"def"</span> },
194+
logger = <span class="string">"myLogger"</span> })
195+
<span class="keyword">local</span> id, err = rvn:captureException(exception,
196+
{ tags = { foo = <span class="string">"bar"</span>, abc = <span class="string">"def"</span> }})</pre>
192197
</ul>
193198

194199
</dd>
@@ -229,12 +234,11 @@ <h3>Returns:</h3>
229234

230235
<h3>Usage:</h3>
231236
<ul>
232-
<pre class="example">
233-
<span class="keyword">local</span> raven = <span class="global">require</span> <span class="string">"raven"</span>
234-
<span class="keyword">local</span> rvn = raven:new(dsn, { tags = { foo = <span class="string">"bar"</span>, abc = <span class="string">"def"</span> },
235-
logger = <span class="string">"myLogger"</span> })
236-
<span class="keyword">local</span> id, err = rvn:captureMessage(<span class="string">"Sample message"</span>,
237-
{ tags = { foo = <span class="string">"bar"</span>, abc = <span class="string">"def"</span> }})</pre>
237+
<pre class="example"><span class="keyword">local</span> raven = <span class="global">require</span> <span class="string">"raven"</span>
238+
<span class="keyword">local</span> rvn = raven:new(dsn, { tags = { foo = <span class="string">"bar"</span>, abc = <span class="string">"def"</span> },
239+
logger = <span class="string">"myLogger"</span> })
240+
<span class="keyword">local</span> id, err = rvn:captureMessage(<span class="string">"Sample message"</span>,
241+
{ tags = { foo = <span class="string">"bar"</span>, abc = <span class="string">"def"</span> }})</pre>
238242
</ul>
239243

240244
</dd>
@@ -264,18 +268,17 @@ <h3>Parameters:</h3>
264268
<h3>Returns:</h3>
265269
<ol>
266270

267-
"f" 's return value(s)
271+
the same with xpcall
268272
</ol>
269273

270274

271275

272276
<h3>Usage:</h3>
273277
<ul>
274-
<pre class="example">
275-
<span class="keyword">function</span> func(a, b, c)
276-
<span class="keyword">return</span> a * b + c
277-
<span class="keyword">end</span>
278-
<span class="keyword">return</span> rvn:call(func, a, b, c)</pre>
278+
<pre class="example"><span class="keyword">function</span> func(a, b, c)
279+
<span class="keyword">return</span> a * b + c
280+
<span class="keyword">end</span>
281+
<span class="keyword">return</span> rvn:call(func, a, b, c)</pre>
279282
</ul>
280283

281284
</dd>
@@ -285,7 +288,8 @@ <h3>Usage:</h3>
285288
</div> <!-- id="content" -->
286289
</div> <!-- id="main" -->
287290
<div id="about">
288-
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.2</a></i>
291+
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
292+
<i style="float:right;">Last updated 2017-04-12 15:54:56 </i>
289293
</div> <!-- id="about" -->
290294
</div> <!-- id="container" -->
291295
</body>

‎docs/ldoc.css

+18-17
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ del,ins {
2828
text-decoration: none;
2929
}
3030
li {
31-
list-style: disc;
3231
margin-left: 20px;
3332
}
3433
caption,th {
@@ -71,7 +70,7 @@ body {
7170
background-color: #ffffff; margin: 0px;
7271
}
7372

74-
code, tt { font-family: monospace; }
73+
code, tt { font-family: monospace; font-size: 1.1em; }
7574
span.parameter { font-family:monospace; }
7675
span.parameter:after { content:":"; }
7776
span.types:before { content:"("; }
@@ -88,7 +87,7 @@ em { font-style: italic;}
8887

8988
h1 {
9089
font-size: 1.5em;
91-
margin: 0 0 20px 0;
90+
margin: 20px 0 20px 0;
9291
}
9392
h2, h3, h4 { margin: 15px 0 10px 0; }
9493
h2 { font-size: 1.25em; }
@@ -114,24 +113,18 @@ p.name {
114113
padding-top: 1em;
115114
}
116115

117-
pre.example {
118-
background-color: rgb(245, 245, 245);
119-
border: 1px solid silver;
120-
padding: 10px;
121-
margin: 10px 0 10px 0;
122-
font-family: "Andale Mono", monospace;
123-
font-size: .85em;
124-
}
125-
126116
pre {
127117
background-color: rgb(245, 245, 245);
128-
border: 1px solid silver;
118+
border: 1px solid #C0C0C0; /* silver */
129119
padding: 10px;
130120
margin: 10px 0 10px 0;
131121
overflow: auto;
132122
font-family: "Andale Mono", monospace;
133123
}
134124

125+
pre.example {
126+
font-size: .85em;
127+
}
135128

136129
table.index { border: 1px #00007f; }
137130
table.index td { text-align: left; vertical-align: top; }
@@ -159,7 +152,7 @@ table.index td { text-align: left; vertical-align: top; }
159152

160153
#navigation {
161154
float: left;
162-
width: 18em;
155+
width: 14em;
163156
vertical-align: top;
164157
background-color: #f0f0f0;
165158
overflow: visible;
@@ -193,7 +186,7 @@ table.index td { text-align: left; vertical-align: top; }
193186
}
194187

195188
#content {
196-
margin-left: 18em;
189+
margin-left: 14em;
197190
padding: 1em;
198191
width: 700px;
199192
border-left: 2px solid #cccccc;
@@ -286,17 +279,25 @@ ol ul { margin-top: 0px; }
286279
ol ol { margin-top: 0px; }
287280
ul ol { margin-top: 0px; }
288281

282+
/* make the target distinct; helps when we're navigating to a function */
283+
a:target + * {
284+
background-color: #FF9;
285+
}
286+
287+
289288
/* styles for prettification of source */
290289
pre .comment { color: #558817; }
291290
pre .constant { color: #a8660d; }
292291
pre .escape { color: #844631; }
293-
pre .keyword { color: #2239a8; font-weight: bold; }
292+
pre .keyword { color: #aa5050; font-weight: bold; }
294293
pre .library { color: #0e7c6b; }
295294
pre .marker { color: #512b1e; background: #fedc56; font-weight: bold; }
296-
pre .string { color: #a8660d; }
295+
pre .string { color: #8080ff; }
297296
pre .number { color: #f8660d; }
298297
pre .operator { color: #2239a8; font-weight: bold; }
299298
pre .preprocessor, pre .prepro { color: #a33243; }
300299
pre .global { color: #800080; }
300+
pre .user-keyword { color: #800080; }
301301
pre .prompt { color: #558817; }
302302
pre .url { color: #272fc2; text-decoration: underline; }
303+

‎raven.lua

+10-3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
-- @author Jiale Zhi <[email protected]>
2020
-- @copyright (c) 2013-2014, CloudFlare, Inc.
2121
--------------------------------------------------------------------
22+
2223
--pcall(require("luacov"))
2324
local json = require("cjson")
2425
local debug = require("debug")
@@ -221,9 +222,15 @@ _M._parse_dsn = _parse_dsn
221222
-- @param dsn The DSN of the Sentry instance with this format:
222223
-- <pre>{PROTOCOL}://{PUBLIC_KEY}:{SECRET_KEY}@{HOST}/{PATH}{PROJECT_ID}</pre>
223224
-- <pre>http://pub:[email protected]:8080/sentry/proj-id</pre>
224-
-- @param conf client configuration. Conf should be a hash table. Possiable
225-
-- keys are: "tags", "logger". For example:
226-
-- <pre>{ tags = { foo = "bar", abc = "def" }, logger = "myLogger" }</pre>
225+
-- @param conf client configuration. Conf should be a hash table. Possible keys are:
226+
-- <ul>
227+
-- <li><span class="parameter">tags</span> extra tags to include on all reported errors</li>
228+
-- <li><span class="parameter">logger</span></li>
229+
-- <li><span class="parameter">verify_ssl</span> boolean of whether to perform SSL certificate verification</li>
230+
-- <li><span class="parameter">cacert</span> path to CA certificate bundle file (defaults to ./data/cacert.pem)</li>
231+
-- </ul>
232+
-- For example:
233+
-- <pre>{ tags = { foo = "bar", abc = "def" }, logger = "myLogger", verify_ssl = false }</pre>
227234
-- @return a new raven instance
228235
-- @usage
229236
-- local raven = require "raven"

0 commit comments

Comments
 (0)