doing 2.0.22 → 2.1.0pre
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardoc/checksums +18 -15
- data/.yardoc/object_types +0 -0
- data/.yardoc/objects/root.dat +0 -0
- data/CHANGELOG.md +36 -1
- data/Gemfile.lock +8 -1
- data/README.md +7 -1
- data/Rakefile +23 -4
- data/bin/doing +323 -173
- data/doc/Array.html +354 -1
- data/doc/Doing/Color.html +104 -92
- data/doc/Doing/Completion.html +216 -0
- data/doc/Doing/Configuration.html +340 -5
- data/doc/Doing/Content.html +229 -0
- data/doc/Doing/Errors/DoingNoTraceError.html +1 -1
- data/doc/Doing/Errors/DoingRuntimeError.html +1 -1
- data/doc/Doing/Errors/DoingStandardError.html +1 -1
- data/doc/Doing/Errors/EmptyInput.html +1 -1
- data/doc/Doing/Errors/NoResults.html +1 -1
- data/doc/Doing/Errors/PluginException.html +1 -1
- data/doc/Doing/Errors/UserCancelled.html +1 -1
- data/doc/Doing/Errors/WrongCommand.html +1 -1
- data/doc/Doing/Errors.html +1 -1
- data/doc/Doing/Hooks.html +1 -1
- data/doc/Doing/Item.html +337 -49
- data/doc/Doing/Items.html +444 -35
- data/doc/Doing/LogAdapter.html +139 -51
- data/doc/Doing/Note.html +253 -22
- data/doc/Doing/Pager.html +74 -36
- data/doc/Doing/Plugins.html +1 -1
- data/doc/Doing/Prompt.html +674 -0
- data/doc/Doing/Section.html +354 -0
- data/doc/Doing/Util.html +57 -1
- data/doc/Doing/WWID.html +477 -670
- data/doc/Doing/WWIDFile.html +398 -0
- data/doc/Doing.html +5 -5
- data/doc/GLI/Commands/MarkdownDocumentListener.html +1 -1
- data/doc/GLI/Commands.html +1 -1
- data/doc/GLI.html +1 -1
- data/doc/Hash.html +97 -1
- data/doc/Status.html +37 -3
- data/doc/String.html +599 -23
- data/doc/Symbol.html +3 -3
- data/doc/Time.html +1 -1
- data/doc/_index.html +22 -1
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +8 -2
- data/doc/index.html +8 -2
- data/doc/method_list.html +453 -173
- data/doc/top-level-namespace.html +1 -1
- data/doing.gemspec +3 -0
- data/doing.rdoc +79 -27
- data/example_plugin.rb +5 -5
- data/lib/completion/_doing.zsh +42 -42
- data/lib/completion/doing.bash +10 -10
- data/lib/completion/doing.fish +1 -280
- data/lib/doing/array.rb +36 -0
- data/lib/doing/colors.rb +70 -66
- data/lib/doing/completion/bash_completion.rb +1 -2
- data/lib/doing/completion/fish_completion.rb +1 -1
- data/lib/doing/completion/zsh_completion.rb +1 -1
- data/lib/doing/completion.rb +6 -0
- data/lib/doing/configuration.rb +134 -23
- data/lib/doing/hash.rb +37 -0
- data/lib/doing/item.rb +77 -12
- data/lib/doing/items.rb +125 -0
- data/lib/doing/log_adapter.rb +58 -4
- data/lib/doing/note.rb +53 -1
- data/lib/doing/pager.rb +49 -38
- data/lib/doing/plugins/export/markdown_export.rb +4 -4
- data/lib/doing/plugins/export/template_export.rb +2 -2
- data/lib/doing/plugins/import/calendar_import.rb +4 -4
- data/lib/doing/plugins/import/doing_import.rb +5 -7
- data/lib/doing/plugins/import/timing_import.rb +3 -3
- data/lib/doing/prompt.rb +206 -0
- data/lib/doing/section.rb +30 -0
- data/lib/doing/string.rb +123 -35
- data/lib/doing/util.rb +14 -6
- data/lib/doing/version.rb +1 -1
- data/lib/doing/wwid.rb +307 -614
- data/lib/doing.rb +6 -2
- data/lib/examples/plugins/capture_thing_import.rb +162 -0
- data/rdoc_to_mmd.rb +14 -8
- data/scripts/generate_bash_completions.rb +1 -1
- data/scripts/generate_fish_completions.rb +1 -1
- data/scripts/generate_zsh_completions.rb +1 -1
- metadata +73 -5
- data/lib/doing/wwidfile.rb +0 -117
data/doc/Doing/Items.html
CHANGED
@@ -96,14 +96,55 @@
|
|
96
96
|
|
97
97
|
<dl>
|
98
98
|
<dt>Defined in:</dt>
|
99
|
-
<dd>lib/doing/
|
99
|
+
<dd>lib/doing/items.rb</dd>
|
100
100
|
</dl>
|
101
101
|
|
102
102
|
</div>
|
103
103
|
|
104
|
+
<h2>Overview</h2><div class="docstring">
|
105
|
+
<div class="discussion">
|
106
|
+
<p>Items Array</p>
|
104
107
|
|
105
108
|
|
109
|
+
</div>
|
110
|
+
</div>
|
111
|
+
<div class="tags">
|
112
|
+
|
106
113
|
|
114
|
+
</div>
|
115
|
+
|
116
|
+
|
117
|
+
|
118
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
119
|
+
<ul class="summary">
|
120
|
+
|
121
|
+
<li class="public ">
|
122
|
+
<span class="summary_signature">
|
123
|
+
|
124
|
+
<a href="#sections-instance_method" title="#sections (instance method)">#<strong>sections</strong> ⇒ Object </a>
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
</span>
|
129
|
+
|
130
|
+
|
131
|
+
|
132
|
+
|
133
|
+
|
134
|
+
|
135
|
+
|
136
|
+
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute sections.</p>
|
142
|
+
</div></span>
|
143
|
+
|
144
|
+
</li>
|
145
|
+
|
146
|
+
|
147
|
+
</ul>
|
107
148
|
|
108
149
|
|
109
150
|
|
@@ -119,13 +160,84 @@
|
|
119
160
|
<li class="public ">
|
120
161
|
<span class="summary_signature">
|
121
162
|
|
122
|
-
<a href="#add_section-instance_method" title="#add_section (instance method)">#<strong>add_section</strong>(
|
163
|
+
<a href="#add_section-instance_method" title="#add_section (instance method)">#<strong>add_section</strong>(section, log: false) ⇒ Object </a>
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
</span>
|
168
|
+
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
<span class="summary_desc"><div class='inline'><p>Add a new section to the sections array.</p>
|
178
|
+
</div></span>
|
179
|
+
|
180
|
+
</li>
|
181
|
+
|
182
|
+
|
183
|
+
<li class="public ">
|
184
|
+
<span class="summary_signature">
|
185
|
+
|
186
|
+
<a href="#delete_item-instance_method" title="#delete_item (instance method)">#<strong>delete_item</strong>(item, single: false) ⇒ Object </a>
|
187
|
+
|
188
|
+
|
189
|
+
|
190
|
+
</span>
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
<span class="summary_desc"><div class='inline'><p>Delete an item from the index.</p>
|
201
|
+
</div></span>
|
202
|
+
|
203
|
+
</li>
|
204
|
+
|
205
|
+
|
206
|
+
<li class="public ">
|
207
|
+
<span class="summary_signature">
|
208
|
+
|
209
|
+
<a href="#in_section-instance_method" title="#in_section (instance method)">#<strong>in_section</strong>(section) ⇒ Items </a>
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
</span>
|
214
|
+
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
<span class="summary_desc"><div class='inline'><p>Get a new Items object containing only items in a specified section.</p>
|
224
|
+
</div></span>
|
225
|
+
|
226
|
+
</li>
|
227
|
+
|
228
|
+
|
229
|
+
<li class="public ">
|
230
|
+
<span class="summary_signature">
|
231
|
+
|
232
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ Items </a>
|
123
233
|
|
124
234
|
|
125
235
|
|
126
236
|
</span>
|
127
237
|
|
128
238
|
|
239
|
+
<span class="note title constructor">constructor</span>
|
240
|
+
|
129
241
|
|
130
242
|
|
131
243
|
|
@@ -133,7 +245,7 @@
|
|
133
245
|
|
134
246
|
|
135
247
|
|
136
|
-
<span class="summary_desc"><div class='inline'><p>
|
248
|
+
<span class="summary_desc"><div class='inline'><p>A new instance of Items.</p>
|
137
249
|
</div></span>
|
138
250
|
|
139
251
|
</li>
|
@@ -142,7 +254,7 @@
|
|
142
254
|
<li class="public ">
|
143
255
|
<span class="summary_signature">
|
144
256
|
|
145
|
-
<a href="#
|
257
|
+
<a href="#section%3F-instance_method" title="#section? (instance method)">#<strong>section?</strong>(section) ⇒ Boolean </a>
|
146
258
|
|
147
259
|
|
148
260
|
|
@@ -156,7 +268,8 @@
|
|
156
268
|
|
157
269
|
|
158
270
|
|
159
|
-
<span class="summary_desc"><div class='inline'
|
271
|
+
<span class="summary_desc"><div class='inline'><p>Test if section already exists.</p>
|
272
|
+
</div></span>
|
160
273
|
|
161
274
|
</li>
|
162
275
|
|
@@ -164,7 +277,7 @@
|
|
164
277
|
<li class="public ">
|
165
278
|
<span class="summary_signature">
|
166
279
|
|
167
|
-
<a href="#
|
280
|
+
<a href="#section_titles-instance_method" title="#section_titles (instance method)">#<strong>section_titles</strong> ⇒ Array </a>
|
168
281
|
|
169
282
|
|
170
283
|
|
@@ -178,7 +291,7 @@
|
|
178
291
|
|
179
292
|
|
180
293
|
|
181
|
-
<span class="summary_desc"><div class='inline'><p>
|
294
|
+
<span class="summary_desc"><div class='inline'><p>List sections, title only.</p>
|
182
295
|
</div></span>
|
183
296
|
|
184
297
|
</li>
|
@@ -187,7 +300,7 @@
|
|
187
300
|
<li class="public ">
|
188
301
|
<span class="summary_signature">
|
189
302
|
|
190
|
-
<a href="#
|
303
|
+
<a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> ⇒ Object </a>
|
191
304
|
|
192
305
|
|
193
306
|
|
@@ -201,7 +314,8 @@
|
|
201
314
|
|
202
315
|
|
203
316
|
|
204
|
-
<span class="summary_desc"><div class='inline'
|
317
|
+
<span class="summary_desc"><div class='inline'><p>Output sections and items in Doing file format.</p>
|
318
|
+
</div></span>
|
205
319
|
|
206
320
|
</li>
|
207
321
|
|
@@ -209,7 +323,7 @@
|
|
209
323
|
<li class="public ">
|
210
324
|
<span class="summary_signature">
|
211
325
|
|
212
|
-
<a href="#
|
326
|
+
<a href="#update_item-instance_method" title="#update_item (instance method)">#<strong>update_item</strong>(old_item, new_item) ⇒ Object </a>
|
213
327
|
|
214
328
|
|
215
329
|
|
@@ -223,7 +337,8 @@
|
|
223
337
|
|
224
338
|
|
225
339
|
|
226
|
-
<span class="summary_desc"><div class='inline'
|
340
|
+
<span class="summary_desc"><div class='inline'><p>Update an item in the index with a modified item.</p>
|
341
|
+
</div></span>
|
227
342
|
|
228
343
|
</li>
|
229
344
|
|
@@ -238,6 +353,66 @@
|
|
238
353
|
|
239
354
|
|
240
355
|
|
356
|
+
|
357
|
+
|
358
|
+
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></h3>
|
359
|
+
<p class="inherited"><span class='object_link'><a href="../Array.html#highlight_tags-instance_method" title="Array#highlight_tags (method)">#highlight_tags</a></span>, <span class='object_link'><a href="../Array.html#log_tags-instance_method" title="Array#log_tags (method)">#log_tags</a></span>, <span class='object_link'><a href="../Array.html#nested_hash-instance_method" title="Array#nested_hash (method)">#nested_hash</a></span>, <span class='object_link'><a href="../Array.html#to_tags-instance_method" title="Array#to_tags (method)">#to_tags</a></span>, <span class='object_link'><a href="../Array.html#to_tags!-instance_method" title="Array#to_tags! (method)">#to_tags!</a></span></p>
|
360
|
+
<div id="constructor_details" class="method_details_list">
|
361
|
+
<h2>Constructor Details</h2>
|
362
|
+
|
363
|
+
<div class="method_details first">
|
364
|
+
<h3 class="signature first" id="initialize-instance_method">
|
365
|
+
|
366
|
+
#<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="Doing::Items (class)">Items</a></span></tt>
|
367
|
+
|
368
|
+
|
369
|
+
|
370
|
+
|
371
|
+
|
372
|
+
</h3><div class="docstring">
|
373
|
+
<div class="discussion">
|
374
|
+
<p>Returns a new instance of Items.</p>
|
375
|
+
|
376
|
+
|
377
|
+
</div>
|
378
|
+
</div>
|
379
|
+
<div class="tags">
|
380
|
+
|
381
|
+
|
382
|
+
</div>
|
383
|
+
</div>
|
384
|
+
|
385
|
+
</div>
|
386
|
+
|
387
|
+
<div id="instance_attr_details" class="attr_details">
|
388
|
+
<h2>Instance Attribute Details</h2>
|
389
|
+
|
390
|
+
|
391
|
+
<span id="sections=-instance_method"></span>
|
392
|
+
<div class="method_details first">
|
393
|
+
<h3 class="signature first" id="sections-instance_method">
|
394
|
+
|
395
|
+
#<strong>sections</strong> ⇒ <tt>Object</tt>
|
396
|
+
|
397
|
+
|
398
|
+
|
399
|
+
|
400
|
+
|
401
|
+
</h3><div class="docstring">
|
402
|
+
<div class="discussion">
|
403
|
+
<p>Returns the value of attribute sections.</p>
|
404
|
+
|
405
|
+
|
406
|
+
</div>
|
407
|
+
</div>
|
408
|
+
<div class="tags">
|
409
|
+
|
410
|
+
|
411
|
+
</div>
|
412
|
+
</div>
|
413
|
+
|
414
|
+
</div>
|
415
|
+
|
241
416
|
|
242
417
|
<div id="instance_method_details" class="method_details_list">
|
243
418
|
<h2>Instance Method Details</h2>
|
@@ -246,7 +421,7 @@
|
|
246
421
|
<div class="method_details first">
|
247
422
|
<h3 class="signature first" id="add_section-instance_method">
|
248
423
|
|
249
|
-
#<strong>add_section</strong>(
|
424
|
+
#<strong>add_section</strong>(section, log: false) ⇒ <tt>Object</tt>
|
250
425
|
|
251
426
|
|
252
427
|
|
@@ -254,7 +429,9 @@
|
|
254
429
|
|
255
430
|
</h3><div class="docstring">
|
256
431
|
<div class="discussion">
|
257
|
-
<p>
|
432
|
+
<p>Add a new section to the sections array. Accepts
|
433
|
+
either a Section object, or a title string that will
|
434
|
+
be converted into a Section.</p>
|
258
435
|
|
259
436
|
|
260
437
|
</div>
|
@@ -265,41 +442,108 @@
|
|
265
442
|
|
266
443
|
<li>
|
267
444
|
|
268
|
-
<span class='name'>
|
445
|
+
<span class='name'>section</span>
|
269
446
|
|
270
447
|
|
271
|
-
<span class='type'>(<tt><span class='object_link'><a href="
|
448
|
+
<span class='type'>(<tt><span class='object_link'><a href="Section.html" title="Doing::Section (class)">Section</a></span></tt>)</span>
|
272
449
|
|
273
450
|
|
274
451
|
|
275
452
|
—
|
276
|
-
<div class='inline'><p>The
|
453
|
+
<div class='inline'><p>The section to add. A
|
454
|
+
String value will be converted to
|
455
|
+
Section automatically.</p>
|
456
|
+
</div>
|
457
|
+
|
458
|
+
</li>
|
459
|
+
|
460
|
+
<li>
|
461
|
+
|
462
|
+
<span class='name'>log</span>
|
463
|
+
|
464
|
+
|
465
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
466
|
+
|
467
|
+
|
468
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
469
|
+
|
470
|
+
|
471
|
+
—
|
472
|
+
<div class='inline'><p>Add a log message
|
473
|
+
notifying the user about the
|
474
|
+
creation of the section.</p>
|
277
475
|
</div>
|
278
476
|
|
279
477
|
</li>
|
280
478
|
|
281
479
|
</ul>
|
282
480
|
|
481
|
+
<p class="tag_title">Returns:</p>
|
482
|
+
<ul class="return">
|
483
|
+
|
484
|
+
<li>
|
485
|
+
|
486
|
+
|
487
|
+
<span class='type'></span>
|
488
|
+
|
489
|
+
|
490
|
+
|
491
|
+
|
492
|
+
<div class='inline'><p>nothing</p>
|
493
|
+
</div>
|
494
|
+
|
495
|
+
</li>
|
496
|
+
|
497
|
+
</ul>
|
283
498
|
|
284
499
|
</div>
|
285
500
|
</div>
|
286
501
|
|
287
502
|
<div class="method_details ">
|
288
|
-
<h3 class="signature " id="
|
503
|
+
<h3 class="signature " id="delete_item-instance_method">
|
504
|
+
|
505
|
+
#<strong>delete_item</strong>(item, single: false) ⇒ <tt>Object</tt>
|
289
506
|
|
290
|
-
|
507
|
+
|
291
508
|
|
292
509
|
|
293
510
|
|
511
|
+
</h3><div class="docstring">
|
512
|
+
<div class="discussion">
|
513
|
+
<p>Delete an item from the index</p>
|
294
514
|
|
515
|
+
|
516
|
+
</div>
|
517
|
+
</div>
|
518
|
+
<div class="tags">
|
519
|
+
<p class="tag_title">Parameters:</p>
|
520
|
+
<ul class="param">
|
295
521
|
|
296
|
-
|
522
|
+
<li>
|
523
|
+
|
524
|
+
<span class='name'>item</span>
|
525
|
+
|
526
|
+
|
527
|
+
<span class='type'></span>
|
528
|
+
|
529
|
+
|
530
|
+
|
531
|
+
—
|
532
|
+
<div class='inline'><p>The item</p>
|
533
|
+
</div>
|
534
|
+
|
535
|
+
</li>
|
536
|
+
|
537
|
+
</ul>
|
538
|
+
|
539
|
+
|
540
|
+
</div>
|
297
541
|
</div>
|
298
542
|
|
299
543
|
<div class="method_details ">
|
300
|
-
<h3 class="signature " id="
|
544
|
+
<h3 class="signature " id="in_section-instance_method">
|
301
545
|
|
302
|
-
#<strong>
|
546
|
+
#<strong>in_section</strong>(section) ⇒ <tt><span class='object_link'><a href="" title="Doing::Items (class)">Items</a></span></tt>
|
303
547
|
|
304
548
|
|
305
549
|
|
@@ -307,7 +551,8 @@
|
|
307
551
|
|
308
552
|
</h3><div class="docstring">
|
309
553
|
<div class="discussion">
|
310
|
-
<p>
|
554
|
+
<p>Get a new Items object containing only items in a
|
555
|
+
specified section</p>
|
311
556
|
|
312
557
|
|
313
558
|
</div>
|
@@ -318,7 +563,7 @@
|
|
318
563
|
|
319
564
|
<li>
|
320
565
|
|
321
|
-
<span class='name'>
|
566
|
+
<span class='name'>section</span>
|
322
567
|
|
323
568
|
|
324
569
|
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
@@ -326,56 +571,220 @@
|
|
326
571
|
|
327
572
|
|
328
573
|
—
|
329
|
-
<div class='inline'><p>
|
574
|
+
<div class='inline'><p>section title</p>
|
330
575
|
</div>
|
331
576
|
|
332
577
|
</li>
|
333
578
|
|
579
|
+
</ul>
|
580
|
+
|
581
|
+
<p class="tag_title">Returns:</p>
|
582
|
+
<ul class="return">
|
583
|
+
|
334
584
|
<li>
|
335
585
|
|
336
|
-
<span class='name'>guessed</span>
|
337
586
|
|
587
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Items (class)">Items</a></span></tt>)</span>
|
338
588
|
|
339
|
-
<span class='type'>(<tt>Boolean</tt>)</span>
|
340
589
|
|
341
590
|
|
342
|
-
|
591
|
+
—
|
592
|
+
<div class='inline'><p>Array of items</p>
|
593
|
+
</div>
|
594
|
+
|
595
|
+
</li>
|
596
|
+
|
597
|
+
</ul>
|
598
|
+
|
599
|
+
</div>
|
600
|
+
</div>
|
601
|
+
|
602
|
+
<div class="method_details ">
|
603
|
+
<h3 class="signature " id="section?-instance_method">
|
604
|
+
|
605
|
+
#<strong>section?</strong>(section) ⇒ <tt>Boolean</tt>
|
606
|
+
|
607
|
+
|
608
|
+
|
609
|
+
|
610
|
+
|
611
|
+
</h3><div class="docstring">
|
612
|
+
<div class="discussion">
|
613
|
+
<p>Test if section already exists</p>
|
614
|
+
|
615
|
+
|
616
|
+
</div>
|
617
|
+
</div>
|
618
|
+
<div class="tags">
|
619
|
+
<p class="tag_title">Parameters:</p>
|
620
|
+
<ul class="param">
|
621
|
+
|
622
|
+
<li>
|
623
|
+
|
624
|
+
<span class='name'>section</span>
|
625
|
+
|
626
|
+
|
627
|
+
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
628
|
+
|
343
629
|
|
344
630
|
|
345
631
|
—
|
346
|
-
<div class='inline'><p>
|
632
|
+
<div class='inline'><p>section title</p>
|
347
633
|
</div>
|
348
634
|
|
349
635
|
</li>
|
350
636
|
|
351
637
|
</ul>
|
352
638
|
|
639
|
+
<p class="tag_title">Returns:</p>
|
640
|
+
<ul class="return">
|
641
|
+
|
642
|
+
<li>
|
643
|
+
|
644
|
+
|
645
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
646
|
+
|
647
|
+
|
648
|
+
|
649
|
+
—
|
650
|
+
<div class='inline'><p>true if section exists</p>
|
651
|
+
</div>
|
652
|
+
|
653
|
+
</li>
|
654
|
+
|
655
|
+
</ul>
|
656
|
+
|
657
|
+
</div>
|
658
|
+
</div>
|
659
|
+
|
660
|
+
<div class="method_details ">
|
661
|
+
<h3 class="signature " id="section_titles-instance_method">
|
662
|
+
|
663
|
+
#<strong>section_titles</strong> ⇒ <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
|
664
|
+
|
665
|
+
|
666
|
+
|
667
|
+
|
668
|
+
|
669
|
+
</h3><div class="docstring">
|
670
|
+
<div class="discussion">
|
671
|
+
<p>List sections, title only</p>
|
672
|
+
|
673
|
+
|
674
|
+
</div>
|
675
|
+
</div>
|
676
|
+
<div class="tags">
|
677
|
+
|
678
|
+
<p class="tag_title">Returns:</p>
|
679
|
+
<ul class="return">
|
680
|
+
|
681
|
+
<li>
|
682
|
+
|
683
|
+
|
684
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
|
685
|
+
|
686
|
+
|
687
|
+
|
688
|
+
—
|
689
|
+
<div class='inline'><p>section titles</p>
|
690
|
+
</div>
|
691
|
+
|
692
|
+
</li>
|
693
|
+
|
694
|
+
</ul>
|
353
695
|
|
354
696
|
</div>
|
355
697
|
</div>
|
356
698
|
|
357
699
|
<div class="method_details ">
|
358
|
-
<h3 class="signature " id="
|
700
|
+
<h3 class="signature " id="to_s-instance_method">
|
359
701
|
|
360
|
-
#<strong>
|
702
|
+
#<strong>to_s</strong> ⇒ <tt>Object</tt>
|
361
703
|
|
362
704
|
|
363
705
|
|
364
706
|
|
365
707
|
|
366
|
-
</h3>
|
708
|
+
</h3><div class="docstring">
|
709
|
+
<div class="discussion">
|
710
|
+
<p>Output sections and items in Doing file format</p>
|
711
|
+
|
712
|
+
|
713
|
+
</div>
|
714
|
+
</div>
|
715
|
+
<div class="tags">
|
716
|
+
|
717
|
+
|
718
|
+
</div>
|
367
719
|
</div>
|
368
720
|
|
369
721
|
<div class="method_details ">
|
370
|
-
<h3 class="signature " id="
|
722
|
+
<h3 class="signature " id="update_item-instance_method">
|
371
723
|
|
372
|
-
#<strong>
|
724
|
+
#<strong>update_item</strong>(old_item, new_item) ⇒ <tt>Object</tt>
|
373
725
|
|
374
726
|
|
375
727
|
|
376
728
|
|
377
729
|
|
378
|
-
</h3>
|
730
|
+
</h3><div class="docstring">
|
731
|
+
<div class="discussion">
|
732
|
+
<p>Update an item in the index with a modified item</p>
|
733
|
+
|
734
|
+
|
735
|
+
</div>
|
736
|
+
</div>
|
737
|
+
<div class="tags">
|
738
|
+
<p class="tag_title">Parameters:</p>
|
739
|
+
<ul class="param">
|
740
|
+
|
741
|
+
<li>
|
742
|
+
|
743
|
+
<span class='name'>old_item</span>
|
744
|
+
|
745
|
+
|
746
|
+
<span class='type'></span>
|
747
|
+
|
748
|
+
|
749
|
+
|
750
|
+
—
|
751
|
+
<div class='inline'><p>The old item</p>
|
752
|
+
</div>
|
753
|
+
|
754
|
+
</li>
|
755
|
+
|
756
|
+
<li>
|
757
|
+
|
758
|
+
<span class='name'>new_item</span>
|
759
|
+
|
760
|
+
|
761
|
+
<span class='type'></span>
|
762
|
+
|
763
|
+
|
764
|
+
|
765
|
+
—
|
766
|
+
<div class='inline'><p>The new item</p>
|
767
|
+
</div>
|
768
|
+
|
769
|
+
</li>
|
770
|
+
|
771
|
+
</ul>
|
772
|
+
|
773
|
+
<p class="tag_title">Raises:</p>
|
774
|
+
<ul class="raise">
|
775
|
+
|
776
|
+
<li>
|
777
|
+
|
778
|
+
|
779
|
+
<span class='type'>(<tt>ItemNotFound</tt>)</span>
|
780
|
+
|
781
|
+
|
782
|
+
|
783
|
+
</li>
|
784
|
+
|
785
|
+
</ul>
|
786
|
+
|
787
|
+
</div>
|
379
788
|
</div>
|
380
789
|
|
381
790
|
</div>
|
@@ -383,7 +792,7 @@
|
|
383
792
|
</div>
|
384
793
|
|
385
794
|
<div id="footer">
|
386
|
-
Generated on
|
795
|
+
Generated on Sat Nov 27 10:06:03 2021 by
|
387
796
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
388
797
|
0.9.26 (ruby-3.0.1).
|
389
798
|
</div>
|