my_help 1.2.2 → 1.2.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/.yardoc/checksums +4 -4
  3. data/.yardoc/objects/root.dat +0 -0
  4. data/Gemfile.lock +1 -1
  5. data/Rakefile +20 -1
  6. data/lib/my_help/cli.rb +1 -0
  7. data/lib/my_help/config.rb +1 -1
  8. data/lib/my_help/list.rb +5 -3
  9. data/lib/my_help/version.rb +1 -1
  10. data/lib/templates/example.org +3 -5
  11. metadata +2 -30
  12. data/doc/MyHelp/CLI.html +0 -749
  13. data/doc/MyHelp/Config.html +0 -693
  14. data/doc/MyHelp/Control.html +0 -1127
  15. data/doc/MyHelp/Error.html +0 -124
  16. data/doc/MyHelp/GetConfig.html +0 -196
  17. data/doc/MyHelp/Git.html +0 -291
  18. data/doc/MyHelp/Init.html +0 -449
  19. data/doc/MyHelp/List.html +0 -577
  20. data/doc/MyHelp/Md2Hash.html +0 -632
  21. data/doc/MyHelp/Modify.html +0 -393
  22. data/doc/MyHelp/Org2Hash.html +0 -542
  23. data/doc/MyHelp.html +0 -135
  24. data/doc/Org2Yaml.html +0 -497
  25. data/doc/OrgToYaml.html +0 -497
  26. data/doc/_index.html +0 -230
  27. data/doc/class_list.html +0 -51
  28. data/doc/css/common.css +0 -1
  29. data/doc/css/full_list.css +0 -58
  30. data/doc/css/style.css +0 -497
  31. data/doc/file.README.html +0 -181
  32. data/doc/file_list.html +0 -56
  33. data/doc/frames.html +0 -17
  34. data/doc/index.html +0 -181
  35. data/doc/js/app.js +0 -314
  36. data/doc/js/full_list.js +0 -216
  37. data/doc/js/jquery.js +0 -4
  38. data/doc/method_list.html +0 -451
  39. data/doc/top-level-namespace.html +0 -112
data/doc/MyHelp/Modify.html DELETED
@@ -1,393 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <title>
7
- Class: MyHelp::Modify
8
-
9
- &mdash; Documentation by YARD 0.9.28
10
-
11
- </title>
12
-
13
- <link rel="stylesheet" href="../css/style.css" type="text/css" />
14
-
15
- <link rel="stylesheet" href="../css/common.css" type="text/css" />
16
-
17
- <script type="text/javascript">
18
- pathId = "MyHelp::Modify";
19
- relpath = '../';
20
- </script>
21
-
22
-
23
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
24
-
25
- <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
26
-
27
-
28
- </head>
29
- <body>
30
- <div class="nav_wrap">
31
- <iframe id="nav" src="../class_list.html?1"></iframe>
32
- <div id="resizer"></div>
33
- </div>
34
-
35
- <div id="main" tabindex="-1">
36
- <div id="header">
37
- <div id="menu">
38
-
39
- <a href="../_index.html">Index (M)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../MyHelp.html" title="MyHelp (module)">MyHelp</a></span></span>
41
- &raquo;
42
- <span class="title">Modify</span>
43
-
44
- </div>
45
-
46
- <div id="search">
47
-
48
- <a class="full_list_link" id="class_list_link"
49
- href="../class_list.html">
50
-
51
- <svg width="24" height="24">
52
- <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
- <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
- <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
- </svg>
56
- </a>
57
-
58
- </div>
59
- <div class="clear"></div>
60
- </div>
61
-
62
- <div id="content"><h1>Class: MyHelp::Modify
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName">Object</span>
73
-
74
- <ul class="fullTree">
75
- <li>Object</li>
76
-
77
- <li class="next">MyHelp::Modify</li>
78
-
79
- </ul>
80
- <a href="#" class="inheritanceTree">show all</a>
81
-
82
- </dd>
83
- </dl>
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
-
95
- <dl>
96
- <dt>Defined in:</dt>
97
- <dd>lib/my_help/modify.rb</dd>
98
- </dl>
99
-
100
- </div>
101
-
102
-
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
- <h2>
111
- Instance Method Summary
112
- <small><a href="#" class="summary_toggle">collapse</a></small>
113
- </h2>
114
-
115
- <ul class="summary">
116
-
117
- <li class="public ">
118
- <span class="summary_signature">
119
-
120
- <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(help_file) &#x21d2; Object </a>
121
-
122
-
123
-
124
- </span>
125
-
126
-
127
-
128
-
129
-
130
-
131
-
132
-
133
-
134
- <span class="summary_desc"><div class='inline'></div></span>
135
-
136
- </li>
137
-
138
-
139
- <li class="public ">
140
- <span class="summary_signature">
141
-
142
- <a href="#edit-instance_method" title="#edit (instance method)">#<strong>edit</strong>(help_name) &#x21d2; Object </a>
143
-
144
-
145
-
146
- </span>
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
- <span class="summary_desc"><div class='inline'></div></span>
157
-
158
- </li>
159
-
160
-
161
- <li class="public ">
162
- <span class="summary_signature">
163
-
164
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(conf) &#x21d2; Modify </a>
165
-
166
-
167
-
168
- </span>
169
-
170
-
171
- <span class="note title constructor">constructor</span>
172
-
173
-
174
-
175
-
176
-
177
-
178
-
179
-
180
- <span class="summary_desc"><div class='inline'>
181
- <p>A new instance of Modify.</p>
182
- </div></span>
183
-
184
- </li>
185
-
186
-
187
- <li class="public ">
188
- <span class="summary_signature">
189
-
190
- <a href="#new-instance_method" title="#new (instance method)">#<strong>new</strong>(help_file) &#x21d2; Object </a>
191
-
192
-
193
-
194
- </span>
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
- <span class="summary_desc"><div class='inline'></div></span>
205
-
206
- </li>
207
-
208
-
209
- </ul>
210
-
211
-
212
- <div id="constructor_details" class="method_details_list">
213
- <h2>Constructor Details</h2>
214
-
215
- <div class="method_details first">
216
- <h3 class="signature first" id="initialize-instance_method">
217
-
218
- #<strong>initialize</strong>(conf) &#x21d2; <tt><span class='object_link'><a href="" title="MyHelp::Modify (class)">Modify</a></span></tt>
219
-
220
-
221
-
222
-
223
-
224
- </h3><div class="docstring">
225
- <div class="discussion">
226
-
227
- <p>Returns a new instance of Modify.</p>
228
-
229
-
230
- </div>
231
- </div>
232
- <div class="tags">
233
-
234
-
235
- </div><table class="source_code">
236
- <tr>
237
- <td>
238
- <pre class="lines">
239
-
240
-
241
- 3
242
- 4
243
- 5</pre>
244
- </td>
245
- <td>
246
- <pre class="code"><span class="info file"># File 'lib/my_help/modify.rb', line 3</span>
247
-
248
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_conf'>conf</span><span class='rparen'>)</span>
249
- <span class='ivar'>@conf</span> <span class='op'>=</span> <span class='id identifier rubyid_conf'>conf</span>
250
- <span class='kw'>end</span></pre>
251
- </td>
252
- </tr>
253
- </table>
254
- </div>
255
-
256
- </div>
257
-
258
-
259
- <div id="instance_method_details" class="method_details_list">
260
- <h2>Instance Method Details</h2>
261
-
262
-
263
- <div class="method_details first">
264
- <h3 class="signature first" id="delete-instance_method">
265
-
266
- #<strong>delete</strong>(help_file) &#x21d2; <tt>Object</tt>
267
-
268
-
269
-
270
-
271
-
272
- </h3><table class="source_code">
273
- <tr>
274
- <td>
275
- <pre class="lines">
276
-
277
-
278
- 13
279
- 14
280
- 15
281
- 16
282
- 17
283
- 18
284
- 19</pre>
285
- </td>
286
- <td>
287
- <pre class="code"><span class="info file"># File 'lib/my_help/modify.rb', line 13</span>
288
-
289
- <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_help_file'>help_file</span><span class='rparen'>)</span>
290
- <span class='kw'>if</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exist?'>exist?</span><span class='lparen'>(</span><span class='id identifier rubyid_help_file'>help_file</span><span class='rparen'>)</span>
291
- <span class='const'>FileUtils</span><span class='period'>.</span><span class='id identifier rubyid_rm'>rm</span><span class='lparen'>(</span><span class='id identifier rubyid_help_file'>help_file</span><span class='comma'>,</span> <span class='label'>verbose:</span> <span class='ivar'>@conf</span><span class='lbracket'>[</span><span class='symbol'>:verbose</span><span class='rbracket'>]</span><span class='rparen'>)</span>
292
- <span class='kw'>else</span>
293
- <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>file </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_help_file'>help_file</span><span class='embexpr_end'>}</span><span class='tstring_content'> does not exist.</span><span class='tstring_end'>&quot;</span></span>
294
- <span class='kw'>end</span>
295
- <span class='kw'>end</span></pre>
296
- </td>
297
- </tr>
298
- </table>
299
- </div>
300
-
301
- <div class="method_details ">
302
- <h3 class="signature " id="edit-instance_method">
303
-
304
- #<strong>edit</strong>(help_name) &#x21d2; <tt>Object</tt>
305
-
306
-
307
-
308
-
309
-
310
- </h3><table class="source_code">
311
- <tr>
312
- <td>
313
- <pre class="lines">
314
-
315
-
316
- 21
317
- 22
318
- 23
319
- 24
320
- 25
321
- 26
322
- 27
323
- 28
324
- 29
325
- 30
326
- 31</pre>
327
- </td>
328
- <td>
329
- <pre class="code"><span class="info file"># File 'lib/my_help/modify.rb', line 21</span>
330
-
331
- <span class='kw'>def</span> <span class='id identifier rubyid_edit'>edit</span><span class='lparen'>(</span><span class='id identifier rubyid_help_name'>help_name</span><span class='rparen'>)</span>
332
- <span class='id identifier rubyid_p'>p</span> <span class='id identifier rubyid_help_file'>help_file</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='ivar'>@conf</span><span class='lbracket'>[</span><span class='symbol'>:local_help_dir</span><span class='rbracket'>]</span><span class='comma'>,</span>
333
- <span class='id identifier rubyid_help_name'>help_name</span> <span class='op'>+</span> <span class='ivar'>@conf</span><span class='lbracket'>[</span><span class='symbol'>:ext</span><span class='rbracket'>]</span><span class='rparen'>)</span>
334
- <span class='kw'>if</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_exist?'>exist?</span><span class='lparen'>(</span><span class='id identifier rubyid_help_file'>help_file</span><span class='rparen'>)</span>
335
- <span class='id identifier rubyid_p'>p</span> <span class='id identifier rubyid_comm'>comm</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@conf</span><span class='lbracket'>[</span><span class='symbol'>:editor</span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_help_file'>help_file</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
336
- <span class='id identifier rubyid_system'>system</span><span class='lparen'>(</span><span class='id identifier rubyid_comm'>comm</span><span class='rparen'>)</span>
337
- <span class='kw'>else</span>
338
- <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>file </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_help_file'>help_file</span><span class='embexpr_end'>}</span><span class='tstring_content'> does not exist,</span><span class='tstring_end'>&quot;</span></span>
339
- <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>make </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_help_name'>help_name</span><span class='embexpr_end'>}</span><span class='tstring_content'> first by &#39;new&#39; command.</span><span class='tstring_end'>&quot;</span></span>
340
- <span class='kw'>end</span>
341
- <span class='kw'>end</span></pre>
342
- </td>
343
- </tr>
344
- </table>
345
- </div>
346
-
347
- <div class="method_details ">
348
- <h3 class="signature " id="new-instance_method">
349
-
350
- #<strong>new</strong>(help_file) &#x21d2; <tt>Object</tt>
351
-
352
-
353
-
354
-
355
-
356
- </h3><table class="source_code">
357
- <tr>
358
- <td>
359
- <pre class="lines">
360
-
361
-
362
- 7
363
- 8
364
- 9
365
- 10
366
- 11</pre>
367
- </td>
368
- <td>
369
- <pre class="code"><span class="info file"># File 'lib/my_help/modify.rb', line 7</span>
370
-
371
- <span class='kw'>def</span> <span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_help_file'>help_file</span><span class='rparen'>)</span>
372
- <span class='id identifier rubyid_target'>target</span> <span class='op'>=</span> <span class='id identifier rubyid_help_file'>help_file</span>
373
- <span class='id identifier rubyid_source'>source</span> <span class='op'>=</span> <span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='ivar'>@conf</span><span class='lbracket'>[</span><span class='symbol'>:template_dir</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>example.org</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
374
- <span class='const'>FileUtils</span><span class='period'>.</span><span class='id identifier rubyid_cp'>cp</span><span class='lparen'>(</span><span class='id identifier rubyid_source'>source</span><span class='comma'>,</span> <span class='id identifier rubyid_target'>target</span><span class='comma'>,</span> <span class='label'>verbose:</span> <span class='ivar'>@conf</span><span class='lbracket'>[</span><span class='symbol'>:verbose</span><span class='rbracket'>]</span><span class='rparen'>)</span>
375
- <span class='kw'>end</span></pre>
376
- </td>
377
- </tr>
378
- </table>
379
- </div>
380
-
381
- </div>
382
-
383
- </div>
384
-
385
- <div id="footer">
386
- Generated on Fri Jan 6 13:07:57 2023 by
387
- <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
388
- 0.9.28 (ruby-3.0.2).
389
- </div>
390
-
391
- </div>
392
- </body>
393
- </html>