From: El_Hoy <eloyesp@...>
Date: 2014-08-10T20:56:14-03:00
Subject: [ruby-core:64292] Re: [ruby-trunk - Bug #10105] [Assigned] Mixed styles for class methods on Tempfile break RDocs.

--e89a8f6433662f144f05004f30bd
Content-Type: text/plain; charset=UTF-8

I've tried to fix it only touching documentation, and it seems to be
impossible, rdoc does not understand the `class << self` syntax (I
understand rdoc in this point, ruby is not easy to parse). I've added an
issue in Rdoc for it ( https://github.com/rdoc/rdoc/issues/317 ).

So the Tempfile.open method needs to be redefined to be understand by rdoc.

I've updated the pull request with the minimal change that will fix the
issue **I don't like it** as it define class methods outside of the class
itself (so the source is harder to read), and it hardcode the class name
two times (that I think is ugly).

I quite not understand why there is so much resistance to refactor the code
for readability.



---  Eloy


2014-08-07 21:36 GMT-03:00 <e@zzak.io>:

> Issue #10105 has been updated by Zachary Scott.
>
> Status changed from Third Party's Issue to Assigned
> Assignee changed from Eric Hodel to Zachary Scott
>
> This may be a bug in RDoc, but we can fix it without redefining the
> methods by using the document method directive:
>
> See
> http://docs.seattlerb.org/rdoc/RDoc/Parser/Ruby.html#class-RDoc::Parser::Ruby-label-Metaprogrammed+Methods
>
> Could you send a patch for this instead?
>
> ----------------------------------------
> Bug #10105: Mixed styles for class methods on Tempfile break RDocs.
> https://bugs.ruby-lang.org/issues/10105#change-48241
>
> * Author: Eloy Esp
> * Status: Assigned
> * Priority: Normal
> * Assignee: Zachary Scott
> * Category: doc
> * Target version:
> * ruby -v: 2.1.1
> * Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN
> ----------------------------------------
> I've already made a little pull request here
> https://github.com/ruby/ruby/pull/691.
>
> The diff is here: https://github.com/ruby/ruby/pull/691.diff
>
> But to make the real changes clear is it better to ignore white-space (as
> there are many indentation changes).
>
> Changes ignoring white-space:
> https://github.com/ruby/ruby/pull/691/files?w=1
>
> Regards.
>
>
>
> --
> https://bugs.ruby-lang.org/
>

--e89a8f6433662f144f05004f30bd
Content-Type: text/html; charset=UTF-8
Content-Transfer-Encoding: quoted-printable

<div dir=3D"ltr"><div class=3D"gmail_default" style=3D"color:rgb(56,118,29)=
">I&#39;ve tried to fix it only touching documentation, and it seems to be =
impossible, rdoc does not understand the `class &lt;&lt; self` syntax (I un=
derstand rdoc in this point, ruby is not easy to parse). I&#39;ve added an =
issue in Rdoc for it ( <a href=3D"https://github.com/rdoc/rdoc/issues/317">=
https://github.com/rdoc/rdoc/issues/317</a> ).<br>

<br>So the Tempfile.open method needs to be redefined to be understand by r=
doc.<br><br></div><div class=3D"gmail_default" style=3D"color:rgb(56,118,29=
)">I&#39;ve updated the pull request with the minimal change that will fix =
the issue **I don&#39;t like it** as it define class methods outside of the=
 class itself (so the source is harder to read), and it hardcode the class =
name two times (that I think is ugly).<br>

<br></div><div class=3D"gmail_default" style=3D"color:rgb(56,118,29)">I qui=
te not understand why there is so much resistance to refactor the code for =
readability.<br></div><div class=3D"gmail_default" style=3D"color:rgb(56,11=
8,29)">

<br><br></div></div><div class=3D"gmail_extra"><br clear=3D"all"><div><div =
dir=3D"ltr"><span style=3D"color:rgb(56,118,29)"><span style=3D"font-family=
:arial,helvetica,sans-serif">---=C2=A0 Eloy</span></span><br></div></div>
<br><br><div class=3D"gmail_quote">2014-08-07 21:36 GMT-03:00  <span dir=3D=
"ltr">&lt;<a href=3D"mailto:e@zzak.io" target=3D"_blank">e@zzak.io</a>&gt;<=
/span>:<br><blockquote class=3D"gmail_quote" style=3D"margin:0 0 0 .8ex;bor=
der-left:1px #ccc solid;padding-left:1ex">

Issue #10105 has been updated by Zachary Scott.<br>
<br>
Status changed from Third Party&#39;s Issue to Assigned<br>
Assignee changed from Eric Hodel to Zachary Scott<br>
<br>
This may be a bug in RDoc, but we can fix it without redefining the methods=
 by using the document method directive:<br>
<br>
See <a href=3D"http://docs.seattlerb.org/rdoc/RDoc/Parser/Ruby.html#class-R=
Doc::Parser::Ruby-label-Metaprogrammed+Methods" target=3D"_blank">http://do=
cs.seattlerb.org/rdoc/RDoc/Parser/Ruby.html#class-RDoc::Parser::Ruby-label-=
Metaprogrammed+Methods</a><br>


<br>
Could you send a patch for this instead?<br>
<div class=3D""><br>
----------------------------------------<br>
Bug #10105: Mixed styles for class methods on Tempfile break RDocs.<br>
</div><a href=3D"https://bugs.ruby-lang.org/issues/10105#change-48241" targ=
et=3D"_blank">https://bugs.ruby-lang.org/issues/10105#change-48241</a><br>
<br>
* Author: Eloy Esp<br>
* Status: Assigned<br>
* Priority: Normal<br>
* Assignee: Zachary Scott<br>
<div class=3D"HOEnZb"><div class=3D"h5">* Category: doc<br>
* Target version:<br>
* ruby -v: 2.1.1<br>
* Backport: 2.0.0: UNKNOWN, 2.1: UNKNOWN<br>
----------------------------------------<br>
I&#39;ve already made a little pull request here <a href=3D"https://github.=
com/ruby/ruby/pull/691" target=3D"_blank">https://github.com/ruby/ruby/pull=
/691</a>.<br>
<br>
The diff is here: <a href=3D"https://github.com/ruby/ruby/pull/691.diff" ta=
rget=3D"_blank">https://github.com/ruby/ruby/pull/691.diff</a><br>
<br>
But to make the real changes clear is it better to ignore white-space (as t=
here are many indentation changes).<br>
<br>
Changes ignoring white-space: <a href=3D"https://github.com/ruby/ruby/pull/=
691/files?w=3D1" target=3D"_blank">https://github.com/ruby/ruby/pull/691/fi=
les?w=3D1</a><br>
<br>
Regards.<br>
<br>
<br>
<br>
--<br>
<a href=3D"https://bugs.ruby-lang.org/" target=3D"_blank">https://bugs.ruby=
-lang.org/</a><br>
</div></div></blockquote></div><br></div>

--e89a8f6433662f144f05004f30bd--