--000e0cd2de30ee3ea70461df4eda
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable

One project that has been in the works for a while and shows a lot of
promise is YARD. The maintainer got sick a while back but has now returned
and is proceeding full-steam-ahead.
YARD supports structured docs (@param foo<String>) but also allows for
rdoc-style completely unstructured docs if that's your piece of cake.
Personally, I find that I prefer rdoc style in application and structured
style in languages, libraries, and frameworks.

YARD has its own parser, so it would be a worthy replacement for rdoc.

-- Yehuda

2009/2/1 Luiz Vitor Martinez Cardoso <grabber / gmail.com>

> People,
>
> Look for that: http://docs.python.org/download.html, try to search some
> functions/methods in "Quick Search" field (example: bisect, urllib, re...).
> The search field is missing at ruby, and it's make the job easier.
>
> The layout of the doc core system is another point. We need to improve the
> interface, show minus things and be more expressive.
>
> Note that I'm nothing suggesting solutions, just putting the problems on
> the table. If the community shows this demand I'll happy to help improve it!
>
>
> Regards,
> Luiz Vitor.
>
>
> On Sun, Feb 1, 2009 at 2:42 PM, <znmeb / cesmail.net> wrote:
>
>> Quoting Austin Ziegler <halostatue / gmail.com>:
>>
>>  On Sun, Feb 1, 2009 at 10:51 AM, Luiz Vitor Martinez Cardoso
>>> <grabber / gmail.com> wrote:
>>>
>>>> What the Ruby community think about developing a better documentation
>>>> system. Something like Python Documentation?
>>>>
>>>
>>> I'm not familiar with "Python Documentation". What exactly do you mean
>>> by "documentation system" (that is, what do you feel that Ruby
>>> currently offers), and what do you mean by "better" (that is, what do
>>> you feel that Ruby currently lacks).
>>>
>>> -austin
>>> --
>>> Austin Ziegler * halostatue / gmail.com * http://www.halostatue.ca/
>>>               * austin / halostatue.ca * http://www.halostatue.ca/feed/
>>>               * austin / zieglers.ca
>>>
>>>
>>>
>> I'm not familiar with Python documentation either. And I know we've had
>> this discussion before, but I'm a big fan of "literate programming" and
>> "reproducible research."
>>
>> As a "community member", though, I'd expect changes to the "documentation
>> system" to be created the same way everything else here is created -- by
>> patches, discussions on mailing lists and in IRC, test-driven and
>> behavior-driven development, etc. So if the original poster has some ideas,
>> I'd certainly like to see what they are, and how they compare with RDoc /
>> RI. Anybody can start a project on RubyForge or Github, and some projects
>> are appealing enough that developers will gravitate to them.
>>
>> When I run out of other interesting projects, I might revisit the whole
>> "literate programming in Ruby" concept. But the thing is -- what I want to
>> do already exists in the R language because some R community members built
>> it. So there's little incentive for me to actually create something. :)
>>
>>
>> --
>> M. Edward (Ed) Borasky
>>
>> I've never met a happy clam. In fact, most of them were pretty steamed.
>>
>>
>
>
> --
> Regards,
>
> Luiz Vitor Martinez Cardoso
> cel.: (11) 8187-8662
> blog: rubz.org
> engineer student at maua.br
>
> "Posso nunca chegar a ser o melhor engenheiro do mundo, mas tenha certeza
> de que eu vou lutar com todas as minhas forÝ┬s para ser o melhor engenheiro
> que eu puder ser"
>



-- 
Yehuda Katz
Developer | Engine Yard
(ph) 718.877.1325

--000e0cd2de30ee3ea70461df4eda
Content-Type: text/html; charset=ISO-8859-1
Content-Transfer-Encoding: quoted-printable

One project that has been in the works for a while and shows a lot of promise is YARD. The maintainer got sick a while back but has now returned and is proceeding full-steam-ahead.<div><br></div><div>YARD supports structured docs (@param foo&lt;String&gt;) but also allows for rdoc-style completely unstructured docs if that&#39;s your piece of cake. Personally, I find that I prefer rdoc style in application and structured style in languages, libraries, and frameworks.</div>
<div><br></div><div>YARD has its own parser, so it would be a worthy replacement for rdoc.</div><div><br></div><div>-- Yehuda<br><br><div class="gmail_quote">2009/2/1 Luiz Vitor Martinez Cardoso <span dir="ltr">&lt;grabber / gmail.com&gt;</span><br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">People,<br><br>Look for that: <a href="http://docs.python.org/download.html" target="_blank">http://docs.python.org/download.html</a>, try to search some functions/methods in &quot;Quick Search&quot; field (example: bisect, urllib, re...). The search field is missing at ruby, and it&#39;s make the job easier.<br>

<br>The layout of the doc core system is another point. We need to improve the interface, show minus things and be more expressive.<br><br>Note that I&#39;m nothing suggesting solutions, just putting the problems on the table. If the community shows this demand I&#39;ll happy to help improve it!<br>

<br><br>Regards,<br><font color="#888888">Luiz Vitor.</font><div><div></div><div class="Wj3C7c"><br><br><div class="gmail_quote">On Sun, Feb 1, 2009 at 2:42 PM,  <span dir="ltr">&lt;<a href="mailto:znmeb / cesmail.net" target="_blank">znmeb / cesmail.net</a>&gt;</span> wrote:<br>
<blockquote class="gmail_quote" style="border-left:1px solid rgb(204, 204, 204);margin:0pt 0pt 0pt 0.8ex;padding-left:1ex">
<div>Quoting Austin Ziegler &lt;<a href="mailto:halostatue / gmail.com" target="_blank">halostatue / gmail.com</a>&gt;:<br>
<br>
<blockquote class="gmail_quote" style="border-left:1px solid rgb(204, 204, 204);margin:0pt 0pt 0pt 0.8ex;padding-left:1ex">
On Sun, Feb 1, 2009 at 10:51 AM, Luiz Vitor Martinez Cardoso<br>
&lt;<a href="mailto:grabber / gmail.com" target="_blank">grabber / gmail.com</a>&gt; wrote:<br>
<blockquote class="gmail_quote" style="border-left:1px solid rgb(204, 204, 204);margin:0pt 0pt 0pt 0.8ex;padding-left:1ex">
What the Ruby community think about developing a better documentation<br>
system. Something like Python Documentation?<br>
</blockquote>
<br>
I&#39;m not familiar with &quot;Python Documentation&quot;. What exactly doou mean<br>
by &quot;documentation system&quot; (that is, what do you feel that Ruby<br>
currently offers), and what do you mean by &quot;better&quot; (that is, what do<br>
you feel that Ruby currently lacks).<br>
<br>
-austin<br>
--<br>
Austin Ziegler * <a href="mailto:halostatue / gmail.com" target="_blank">halostatue / gmail.com</a> * <a href="http://www.halostatue.ca/" target="_blank">http://www.halostatue.ca/</a><br>
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; * <a href="mailto:austin / halostatue.ca" target="_blank">austin / halostatue.ca</a> * <a href="http://www.halostatue.ca/feed/" target="_blank">http://www.halostatue.ca/feed/</a><br>
 &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; * <a href="mailto:austin / zieglers.ca" target="_blank">austin / zieglers.ca</a><br>
<br>
<br>
</blockquote>
<br></div>
I&#39;m not familiar with Python documentation either. And I know we&#39;vead this discussion before, but I&#39;m a big fan of &quot;literate programming&quot; and &quot;reproducible research.&quot;<br>
<br>
As a &quot;community member&quot;, though, I&#39;d expect changes to the &quot;documentation system&quot; to be created the same way everything else here is created -- by patches, discussions on mailing lists and in IRC, test-driven and behavior-driven development, etc. So if the original poster hasome ideas, I&#39;d certainly like to see what they are, and how they compare with RDoc / RI. Anybody can start a project on RubyForge or Github, andome projects are appealing enough that developers will gravitate to them.<br>


<br>
When I run out of other interesting projects, I might revisit the whole &quot;literate programming in Ruby&quot; concept. But the thing is -- what I want to do already exists in the R language because some R community membersuilt it. So there&#39;s little incentive for me to actually create something. :)<br>

<font color="#888888">
<br>
<br>
-- <br>
M. Edward (Ed) Borasky<br>
<br>
I&#39;ve never met a happy clam. In fact, most of them were pretty steamed.<br>
<br>
</font></blockquote></div><br><br clear="all"><br></div></div><div><div></div><div class="Wj3C7c">-- <br>Regards, <br><br>Luiz Vitor Martinez Cardoso<br>cel.: (11) 8187-8662 <br>blog: <a href="http://rubz.org" target="_blank">rubz.org</a> <br>
engineer student at <a href="http://maua.br" target="_blank">maua.br</a><br>
<br>&quot;Posso nunca chegar a ser o melhor engenheiro do mundo, mas tenha certeza de que eu vou lutar com todas as minhas forÝ┬s para ser o melhor engenheiro que eu puder ser&quot;<br>
</div></div></blockquote></div><br><br clear="all"><br>-- <br>Yehuda Katz<br>Developer | Engine Yard<br>(ph) 718.877.1325<br>
</div>

--000e0cd2de30ee3ea70461df4eda--