https://redmine.ruby-lang.org/https://redmine.ruby-lang.org/favicon.ico?17113305112018-03-16T23:18:20ZRuby Issue Tracking SystemRuby master - Misc #14610: Enhance Proc docshttps://redmine.ruby-lang.org/issues/14610?journal_id=710472018-03-16T23:18:20Zshevegen (Robert A. Heiler)shevegen@gmail.com
<ul></ul><p>Agreed.</p>
<blockquote>
<p>If my class documentation would be accepted,</p>
</blockquote>
<p>You added a lot more examples too if I understand the patch<br>
correctly, so I guess it is better than the old status quo.</p>
<p>The old status quo did not have ... a lot of examples, which<br>
is not good. Examples help a LOT. They are often easier to<br>
understand than any wall of text - if they work that is. :)</p>
<p>And there was also some more documentation added about Symbols<br>
versus Strings in ruby by ... (I forgot the name, i am so<br>
sorry) some ruby hacker. So I think it is quite likely that<br>
the patch will be added.</p>
<p>The only remark I have to make is that I think the old intro is<br>
a bit better.</p>
<p>E. g.:</p>
<p>"Proc objects are blocks of code that have been bound to<br>
a set of local variables."</p>
<p>versus</p>
<p>"Proc object is an incapsulation of a block of code, that can be<br>
stored in local variables, passed to methods and other procs and<br>
called."</p>
<p>Actually I think I just noticed a typo in your patch. :)</p>
<p>"+Proc+ object is an incapsulation of a block of code, that can<br>
be stored in local variables, passed to methods and other procs<br>
and called."</p>
<p>The part "and called" seems a bit odd. I assume you refer to<br>
"called in another proc"?</p>
<p>Anyway. The above are mostly just details; it's not as if the<br>
old documentation is perfect either. ;)</p>
<p>Some other changes I'd suggest would be e. g.:</p>
<p>"You can tell lambda from regular proc by #lambda? instance method."</p>
<p>towards</p>
<p>"A lambda can be distinguished from a regular proc object by the #lambda? instance method. Example:"</p>
<p>And a single-line example.</p>
<p>Anyway, I agree with your statements above, so my comment should be<br>
seen as suggestions to +1 to your patch. In general the ruby docs<br>
are an area where a lot of things can be made better, so it's great<br>
that people such as you help improve these parts of ruby.</p> Ruby master - Misc #14610: Enhance Proc docshttps://redmine.ruby-lang.org/issues/14610?journal_id=720882018-05-17T07:25:32Znaruse (Yui NARUSE)naruse@airemix.jp
<ul><li><strong>Tracker</strong> changed from <i>Misc</i> to <i>Bug</i></li><li><strong>Assignee</strong> set to <i>13939</i></li><li><strong>Backport</strong> set to <i>2.3: UNKNOWN, 2.4: UNKNOWN, 2.5: UNKNOWN</i></li></ul> Ruby master - Misc #14610: Enhance Proc docshttps://redmine.ruby-lang.org/issues/14610?journal_id=734362018-08-09T10:43:12Zhsbt (Hiroshi SHIBATA)hsbt@ruby-lang.org
<ul><li><strong>Status</strong> changed from <i>Open</i> to <i>Assigned</i></li></ul> Ruby master - Misc #14610: Enhance Proc docshttps://redmine.ruby-lang.org/issues/14610?journal_id=755792018-12-11T22:04:32Zzverok (Victor Shepelev)zverok.offline@gmail.com
<ul><li><strong>Tracker</strong> changed from <i>Bug</i> to <i>Misc</i></li><li><strong>Backport</strong> deleted (<del><i>2.3: UNKNOWN, 2.4: UNKNOWN, 2.5: UNKNOWN</i></del>)</li></ul><blockquote>
<p>Added by zverok (Victor Shepelev) 9 months ago.<br>
Updated by hsbt (Hiroshi SHIBATA) 4 months ago</p>
</blockquote>
<p>Sorry, is it possible to have this merged before 2.6 release? What can I do for it?..</p> Ruby master - Misc #14610: Enhance Proc docshttps://redmine.ruby-lang.org/issues/14610?journal_id=755872018-12-12T01:52:50Zduerst (Martin Dürst)duerst@it.aoyama.ac.jp
<ul><li><strong>Assignee</strong> changed from <i>13939</i> to <i>duerst (Martin Dürst)</i></li></ul><p>I'll try to have a look at it later today or tomorrow.</p> Ruby master - Misc #14610: Enhance Proc docshttps://redmine.ruby-lang.org/issues/14610?journal_id=756002018-12-12T07:37:21Zduerst (Martin Dürst)duerst@it.aoyama.ac.jp
<ul><li><strong>Status</strong> changed from <i>Assigned</i> to <i>Closed</i></li></ul><p>Applied in changeset trunk|r66355.</p>
<hr>
<p>Enhance Proc docs [Misc <a class="issue tracker-5 status-5 priority-4 priority-default closed" title="Misc: Enhance Proc docs (Closed)" href="https://redmine.ruby-lang.org/issues/14610">#14610</a>]</p>
<p>From: Victor Shepelev <a href="mailto:zverok.offline@gmail.com" class="email">zverok.offline@gmail.com</a></p>