Skip to content

Commit f41a6bc

Browse files
committed
📝 Update docs site
1 parent e11cec5 commit f41a6bc

28 files changed

+2523
-567
lines changed

docs/OAuth2.html

Lines changed: 111 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -117,12 +117,78 @@ <h2>
117117
<dl class="constants">
118118

119119
<dt id="OAUTH_DEBUG-constant" class="">OAUTH_DEBUG =
120-
120+
<div class="docstring">
121+
<div class="discussion">
122+
<p>When true, enables verbose HTTP logging via Faraday’s logger middleware.<br />
123+
Controlled by the OAUTH_DEBUG environment variable. Any case-insensitive<br />
124+
value equal to “true” will enable debugging.</p>
125+
126+
127+
</div>
128+
</div>
129+
<div class="tags">
130+
131+
<p class="tag_title">Returns:</p>
132+
<ul class="return">
133+
134+
<li>
135+
136+
137+
<span class='type'>(<tt>Boolean</tt>)</span>
138+
139+
140+
141+
</li>
142+
143+
</ul>
144+
145+
</div>
121146
</dt>
122147
<dd><pre class="code"><span class='const'>ENV</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>OAUTH_DEBUG</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>false</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_casecmp'>casecmp</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>true</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_zero?'>zero?</span></pre></dd>
123148

124149
<dt id="DEFAULT_CONFIG-constant" class="">DEFAULT_CONFIG =
125-
150+
<div class="docstring">
151+
<div class="discussion">
152+
<p>Default configuration values for the oauth2 library.</p>
153+
154+
155+
</div>
156+
</div>
157+
<div class="tags">
158+
159+
<div class="examples">
160+
<h4 class="tag_title">Examples:</h4>
161+
162+
163+
<h5 class="example_title"><div class='inline'><p>Toggle warnings</p>
164+
</div></h5>
165+
166+
<pre class="example code"><code><span class='const'><span class='object_link'><a href="" title="OAuth2 (module)">OAuth2</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'><span class='object_link'><a href="#configure-class_method" title="OAuth2.configure (method)">configure</a></span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
167+
<span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='symbol'>:silence_extra_tokens_warning</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>false</span>
168+
<span class='id identifier rubyid_config'>config</span><span class='lbracket'>[</span><span class='symbol'>:silence_no_tokens_warning</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>false</span>
169+
<span class='kw'>end</span></code></pre>
170+
171+
</div>
172+
173+
<p class="tag_title">Returns:</p>
174+
<ul class="return">
175+
176+
<li>
177+
178+
179+
<span class='type'>(<tt>SnakyHash::SymbolKeyed</tt>)</span>
180+
181+
182+
183+
&mdash;
184+
<div class='inline'><p>A mutable Hash-like config with symbol keys</p>
185+
</div>
186+
187+
</li>
188+
189+
</ul>
190+
191+
</div>
126192
</dt>
127193
<dd><pre class="code"><span class='const'>SnakyHash</span><span class='op'>::</span><span class='const'>SymbolKeyed</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span>
128194
<span class='label'>silence_extra_tokens_warning:</span> <span class='kw'>true</span><span class='comma'>,</span>
@@ -151,7 +217,7 @@ <h2>Class Attribute Summary <small><a href="#" class="summary_toggle">collapse</
151217
<li class="public ">
152218
<span class="summary_signature">
153219

154-
<a href="#config-class_method" title="config (class method)">.<strong>config</strong> &#x21d2; Object </a>
220+
<a href="#config-class_method" title="config (class method)">.<strong>config</strong> &#x21d2; SnakyHash::SymbolKeyed </a>
155221

156222

157223

@@ -170,7 +236,7 @@ <h2>Class Attribute Summary <small><a href="#" class="summary_toggle">collapse</
170236

171237

172238

173-
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute config.</p>
239+
<span class="summary_desc"><div class='inline'><p>Access the current configuration.</p>
174240
</div></span>
175241

176242
</li>
@@ -192,7 +258,7 @@ <h2>
192258
<li class="public ">
193259
<span class="summary_signature">
194260

195-
<a href="#configure-class_method" title="configure (class method)">.<strong>configure</strong> {|@config| ... } &#x21d2; Object </a>
261+
<a href="#configure-class_method" title="configure (class method)">.<strong>configure</strong> {|config| ... } &#x21d2; void </a>
196262

197263

198264

@@ -206,7 +272,7 @@ <h2>
206272

207273

208274

209-
<span class="summary_desc"><div class='inline'>
275+
<span class="summary_desc"><div class='inline'><p>Configure global library behavior.</p>
210276
</div></span>
211277

212278
</li>
@@ -224,34 +290,49 @@ <h2>Class Attribute Details</h2>
224290
<div class="method_details first">
225291
<h3 class="signature first" id="config-class_method">
226292

227-
.<strong>config</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
293+
.<strong>config</strong> &#x21d2; <tt>SnakyHash::SymbolKeyed</tt> <span class="extras">(readonly)</span>
228294

229295

230296

231297

232298

233299
</h3><div class="docstring">
234300
<div class="discussion">
235-
<p>Returns the value of attribute config.</p>
301+
<p>Access the current configuration.</p>
302+
303+
<p>Prefer using <span class='object_link'><a href="#configure-class_method" title="OAuth2.configure (method)">configure</a></span> to mutate configuration.</p>
236304

237305

238306
</div>
239307
</div>
240308
<div class="tags">
241309

310+
<p class="tag_title">Returns:</p>
311+
<ul class="return">
312+
313+
<li>
314+
315+
316+
<span class='type'>(<tt>SnakyHash::SymbolKeyed</tt>)</span>
317+
318+
319+
320+
</li>
321+
322+
</ul>
242323

243324
</div><table class="source_code">
244325
<tr>
245326
<td>
246327
<pre class="lines">
247328

248329

249-
35
250-
36
251-
37</pre>
330+
63
331+
64
332+
65</pre>
252333
</td>
253334
<td>
254-
<pre class="code"><span class="info file"># File 'lib/oauth2.rb', line 35</span>
335+
<pre class="code"><span class="info file"># File 'lib/oauth2.rb', line 63</span>
255336

256337
<span class='kw'>def</span> <span class='id identifier rubyid_config'>config</span>
257338
<span class='ivar'>@config</span>
@@ -271,31 +352,39 @@ <h2>Class Method Details</h2>
271352
<div class="method_details first">
272353
<h3 class="signature first" id="configure-class_method">
273354

274-
.<strong>configure</strong> {|@config| ... } &#x21d2; <tt>Object</tt>
355+
.<strong>configure</strong> {|config| ... } &#x21d2; <tt>void</tt>
275356

276357

277358

278359

279360

280361
</h3><div class="docstring">
281362
<div class="discussion">
282-
363+
<p class="note returns_void">This method returns an undefined value.</p><p>Configure global library behavior.</p>
364+
365+
<p>Yields the mutable configuration object so callers can update settings.</p>
283366

284367

285368
</div>
286369
</div>
287370
<div class="tags">
288371

289-
<p class="tag_title">Yields:</p>
290-
<ul class="yield">
372+
<p class="tag_title">Yield Parameters:</p>
373+
<ul class="yieldparam">
291374

292375
<li>
293376

377+
<span class='name'>config</span>
378+
294379

295-
<span class='type'>(<tt>@<span class='object_link'><a href="#config-class_method" title="OAuth2.config (method)">config</a></span></tt>)</span>
380+
<span class='type'>(<tt>SnakyHash::SymbolKeyed</tt>)</span>
296381

297382

298383

384+
&mdash;
385+
<div class='inline'><p>the configuration object</p>
386+
</div>
387+
299388
</li>
300389

301390
</ul>
@@ -306,12 +395,12 @@ <h3 class="signature first" id="configure-class_method">
306395
<pre class="lines">
307396

308397

309-
37
310-
38
311-
39</pre>
398+
72
399+
73
400+
74</pre>
312401
</td>
313402
<td>
314-
<pre class="code"><span class="info file"># File 'lib/oauth2.rb', line 37</span>
403+
<pre class="code"><span class="info file"># File 'lib/oauth2.rb', line 72</span>
315404

316405
<span class='kw'>def</span> <span class='id identifier rubyid_configure'>configure</span>
317406
<span class='kw'>yield</span> <span class='ivar'>@config</span>
@@ -326,7 +415,7 @@ <h3 class="signature first" id="configure-class_method">
326415
</div>
327416

328417
<div id="footer">
329-
Generated on Thu Aug 7 13:57:43 2025 by
418+
Generated on Sat Aug 30 16:15:06 2025 by
330419
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
331420
0.9.37 (ruby-3.4.5).
332421
</div>

docs/OAuth2/AccessToken.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3069,7 +3069,7 @@ <h3 class="signature " id="to_hash-instance_method">
30693069
</div>
30703070

30713071
<div id="footer">
3072-
Generated on Thu Aug 7 13:57:43 2025 by
3072+
Generated on Sat Aug 30 16:15:06 2025 by
30733073
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
30743074
0.9.37 (ruby-3.4.5).
30753075
</div>

0 commit comments

Comments
 (0)