tag:rubydoc.tenderapp.com,2010-12-26:/discussions/problems/437-a-class-is-missing-in-the-documentationRubydoc.info: Discussion 2016-09-10T23:06:09Ztag:rubydoc.tenderapp.com,2010-12-26:Comment/388187492016-01-29T00:42:11Z2016-01-29T00:42:11ZA class is missing in the documentation<div><p>Can you provide more information as to where you are not seeing
the documentation? A URL would be helpful.</p></div>lsegaltag:rubydoc.tenderapp.com,2010-12-26:Comment/388187492016-01-29T07:56:56Z2016-01-29T07:56:56ZA class is missing in the documentation<div>
<div>Thank you!</div>
<div>The link is</div>
<div><a href=
"http://www.rubydoc.info/gems/robust_excel_ole/0.3.7">http://www.rubydoc.info/gems/robust_excel_ole/0.3.7</a></div>
<div> </div>
<div>Thoams</div>
<div> </div>
<div class="signature">---<br>
Dr. Thomas Raths<br>
Körperpsychotherapie, Theatertherapie, Tanz<br>
<br>
Karmeliterweg 49<br>
13465 Berlin-Frohnau<br>
<br>
0175 - 90 81 668<br>
www.erlebens-raum.de</div>
<div>
<div>
<div name="quote">
<div><b>Gesendet:</b> Freitag, 29. Januar 2016 um 01:42
Uhr<br>
<b>Von:</b> lsegal <tender+d7ef7d1ed6@tenderapp.com><br>
<b>An:</b> thomas.raths@gmx.net<br>
<b>Betreff:</b> Re: A class is missing in the documentation
[Problems #437]</div>
<div name="quoted-content"><!--pre { width: 92.0%; margin:
10.0px 2.0%; padding: 5.0px 2.0%; background: rgb(239,239,239);
border: 1.0px solid rgb(214,214,214); } blockquote { margin-left:
0; padding-left: 1.0em; border-left: 5.0px solid rgb(204,204,204);
} -->
<table width="100%">
<tr>
<td>
<p>// Please reply above this line<br>
==================================================</p>
<p><b>From</b>: lsegal (Support staff)</p>
<div>
<p>Can you provide more information as to where you are not seeing
the documentation? A URL would be helpful.</p>
</div>
<div>
<p>On Sun, Jan 03 at 07:34 AM PST, wrote:</p>
<blockquote>
<div>
<p>We implemented a library "robust_excel_ole". There the class
Book is missing in the documentation.<br>
Do you have any suggestions?<br>
Thank you very much in advance.<br>
Thomas</p>
</div>
</blockquote>
</div>
</td>
</tr>
<tr>
<td>
<p>Having trouble reading this? View this discussion online:
<a href=
"https://rubydoc.tenderapp.com/discussions/problems/437-a-class-is-missing-in-the-documentation">
A class is missing in the documentation</a>.</p>
<p>Reply with #ignore to stop receiving notifications for this
discussion.</p>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>Thomas Rathstag:rubydoc.tenderapp.com,2010-12-26:Comment/388187492016-01-29T11:29:41Z2016-01-29T11:29:41ZA class is missing in the documentation<div><p>I see that you <a href="https://github.com/Thomas008/robust_excel_ole/commit/aa32815ccb715d8f97e8b31eb08baa606bcd89d3">
recently added YARD formatted documentation in your source</a>, but
these additions seem to have come <em>after</em> your <a href="https://rubygems.org/gems/robust_excel_ole">last release
(v0.3.7)</a> (commit was in January 2016, release was December
2015). The gems portion of rubydoc.info only serves from released
gem code, so in order to see this under /gems/robust_excel_ole, you
must release a new version.</p>
<p>That said, if you want to preview, your documentation does seem
to work from the GitHub side of things:</p>
<p><a href="http://www.rubydoc.info/github/Thomas008/robust_excel_ole/master/RobustExcelOle/Excel#new-class_method">
http://www.rubydoc.info/github/Thomas008/robust_excel_ole/master/Ro...</a></p>
<p>Though I would suggest using YARD locally to test this, if
you're looking to preview documentation as you build it up.</p>
<p>Hope that helps!</p></div>lsegaltag:rubydoc.tenderapp.com,2010-12-26:Comment/388187492016-02-05T17:29:28Z2016-02-05T17:29:28ZA class is missing in the documentation<div>
<div>Hello,</div>
<div>thanks a lot for you answer.</div>
<div> </div>
<div>
<p>>That said, if you want to preview, your documentation does
seem to work from the GitHub side of things:</p>
<p><a href=
"http://www.rubydoc.info/github/Thomas008/robust_excel_ole/master/RobustExcelOle/Excel#new-class_method">
>http://www.rubydoc.info/github/Thomas008/robust_excel_ole/master/Ro...</a></p>
</div>
<div>No, it does not work:</div>
<div>The problem is:</div>
<div>The class Book is not displayed.</div>
<div> </div>
<div>>Though I would suggest using YARD locally to test this, if
you're looking to preview documentation as you build it up.</div>
<div>I did it, and the class Book is here displayed.</div>
<div> </div>
<div>How can I let display the class Book?</div>
<div> </div>
<div>Thanks a lot,</div>
<div>Thomas</div>
<div> </div>
<div> </div>
<div><br>
</div>
<div class="signature">---<br>
Dr. Thomas Raths<br>
Körperpsychotherapie, Theatertherapie, Tanz<br>
<br>
Karmeliterweg 49<br>
13465 Berlin-Frohnau<br>
<br>
0175 - 90 81 668<br>
www.erlebens-raum.de</div>
<div>
<div>
<div name="quote">
<div><b>Gesendet:</b> Freitag, 29. Januar 2016 um 12:29
Uhr<br>
<b>Von:</b> lsegal <tender+d7ef7d1ed6@tenderapp.com><br>
<b>An:</b> thomas.raths@gmx.net<br>
<b>Betreff:</b> Re: A class is missing in the documentation
[Problems #437]</div>
<div name="quoted-content"><!--pre { width: 92.0%; margin:
10.0px 2.0%; padding: 5.0px 2.0%; background: rgb(239,239,239);
border: 1.0px solid rgb(214,214,214); } blockquote { margin-left:
0; padding-left: 1.0em; border-left: 5.0px solid rgb(204,204,204);
} -->
<table width="100%">
<tr>
<td>
<p>// Please reply above this line<br>
==================================================</p>
<p><b>From</b>: lsegal (Support staff)</p>
<div>
<p>I see that you <a href=
"https://github.com/Thomas008/robust_excel_ole/commit/aa32815ccb715d8f97e8b31eb08baa606bcd89d3">
recently added YARD formatted documentation in your source</a>, but
these additions seem to have come <em>after</em> your <a href=
"https://rubygems.org/gems/robust_excel_ole">last release
(v0.3.7)</a> (commit was in January 2016, release was December
2015). The gems portion of rubydoc.info only serves from released
gem code, so in order to see this under /gems/robust_excel_ole, you
must release a new version.</p>
<p>That said, if you want to preview, your documentation does seem
to work from the GitHub side of things:</p>
<p><a href=
"http://www.rubydoc.info/github/Thomas008/robust_excel_ole/master/RobustExcelOle/Excel#new-class_method">
http://www.rubydoc.info/github/Thomas008/robust_excel_ole/master/Ro...</a></p>
<p>Though I would suggest using YARD locally to test this, if
you're looking to preview documentation as you build it up.</p>
<p>Hope that helps!</p>
</div>
<div>
<p>On Thu, Jan 28 at 11:56 PM PST, Thomas Raths wrote:</p>
<blockquote>
<div>
<div>Thank you!</div>
<div>The link is</div>
<div><a href=
"http://www.rubydoc.info/gems/robust_excel_ole/0.3.7">http://www.rubydoc.info/gems/robust_excel_ole/0.3.7</a></div>
<div> </div>
<div>Thoams</div>
<div> </div>
<div class="signature">---<br>
Dr. Thomas Raths<br>
Körperpsychotherapie, Theatertherapie, Tanz<br>
<br>
Karmeliterweg 49<br>
13465 Berlin-Frohnau<br>
<br>
0175 - 90 81 668<br>
<a href=
"http://www.erlebens-raum.de">www.erlebens-raum.de</a></div>
<div>
<div>
<div>
<div><b>Gesendet:</b> Freitag, 29. Januar 2016 um 01:42
Uhr<br>
<b>Von:</b> lsegal <[email blocked]><br>
<b>An:</b> [email blocked]<br>
<b>Betreff:</b> Re: A class is missing in the documentation
[Problems #437]</div>
<div><!--pre { width: 92.0%; margin: 10.0px 2.0%; padding: 5.0px
2.0%; background: rgb(239,239,239); border: 1.0px solid
rgb(214,214,214); } blockquote { margin-left: 0; padding-left:
1.0em; border-left: 5.0px solid rgb(204,204,204); } -->
<table width="100%">
<tr>
<td>
<p>// Please reply above this line<br>
==================================================</p>
<p><b>From</b>: lsegal (Support staff)</p>
<div>
<p>Can you provide more information as to where you are not seeing
the documentation? A URL would be helpful.</p>
</div>
<div>
<p>On Sun, Jan 03 at 07:34 AM PST, wrote:</p>
<blockquote>
<div>
<p>We implemented a library "robust_excel_ole". There the class
Book is missing in the documentation.<br>
Do you have any suggestions?<br>
Thank you very much in advance.<br>
Thomas</p>
</div>
</blockquote>
</div>
</td>
</tr>
<tr>
<td>
<p>Having trouble reading this? View this discussion online:
<a href=
"https://rubydoc.tenderapp.com/discussions/problems/437-a-class-is-missing-in-the-documentation">
A class is missing in the documentation</a>.</p>
<p>Reply with #ignore to stop receiving notifications for this
discussion.</p>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
</blockquote>
</div>
</td>
</tr>
<tr>
<td>
<p>Having trouble reading this? View this discussion online:
<a href=
"https://rubydoc.tenderapp.com/discussions/problems/437-a-class-is-missing-in-the-documentation">
A class is missing in the documentation</a>.</p>
<p>Reply with #ignore to stop receiving notifications for this
discussion.</p>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>Thomas Rathstag:rubydoc.tenderapp.com,2010-12-26:Comment/388187492016-02-05T21:17:14Z2016-02-05T21:22:30ZA class is missing in the documentation<div><p>YARD does not generate the Book class locally either. I tried
this out on my machine and noticed at least one syntax error:</p>
<blockquote>
<p>[warn]: Syntax error in
<code>lib/robust_excel_ole/book.rb</code>:(700,25): syntax error,
unexpected ':', expecting keyword_then or ',' or ';' or '\n'</p>
</blockquote>
<p>This is likely the cause on rubydoc.info as well.</p>
<p>Just to clarify, the case/when syntax you are using seems to be
the old 1.8 style syntax. YARD, when run in Ruby 1.9/2.x will by
default use the new ripper parser, which is a 1.9+ parser. Since
rubydoc.info (and my local machine) use Ruby 2.x, the error is
generated in both places. You are probably running YARD in a Ruby
1.8.x, which is why you don't need to turn on legacy mode.</p>
<p>If you <em>really</em> need to use 1.8 style syntax, you can
switch YARD into legacy mode with the <code>--legacy</code> switch,
but note that this is a legacy mode and not receiving any feature
updates (it's effectively a deprecated mode).</p>
<p>The easier fix is to change the colons into semi-colons, which
is both 1.8 and 1.9+ compatible. That seems to fix it for me.</p></div>lsegaltag:rubydoc.tenderapp.com,2010-12-26:Comment/388187492016-02-16T13:26:08Z2016-02-16T13:26:09ZA class is missing in the documentation<div>
<div>YARD now runs without error at my system locally.</div>
<div> </div>
<div>Still, on rubydoc, the class Book is missing, although it is
produced at my system.</div>
<div> </div>
<div>Can it be because of different versions of Yard?</div>
<div>I use the version 0.8.7.6. What version does rubydoc
use?</div>
<div> </div>
<div>Thank you!</div>
<div>Thomas</div>
<div><br>
</div>
<div> </div>
<div class="signature">---<br>
Dr. Thomas Raths<br>
Körperpsychotherapie, Theatertherapie, Tanz<br>
<br>
Karmeliterweg 49<br>
13465 Berlin-Frohnau<br>
<br>
0175 - 90 81 668<br>
www.erlebens-raum.de</div>
<div>
<div>
<div name="quote">
<div><b>Gesendet:</b> Freitag, 05. Februar 2016 um 22:17
Uhr<br>
<b>Von:</b> lsegal <tender+d7ef7d1ed6@tenderapp.com><br>
<b>An:</b> thomas.raths@gmx.net<br>
<b>Betreff:</b> Re: A class is missing in the documentation
[Problems #437]</div>
<div name="quoted-content"><!--pre { width: 92.0%; margin:
10.0px 2.0%; padding: 5.0px 2.0%; background: rgb(239,239,239);
border: 1.0px solid rgb(214,214,214); } blockquote { margin-left:
0; padding-left: 1.0em; border-left: 5.0px solid rgb(204,204,204);
} -->
<table width="100%">
<tr>
<td>
<p>// Please reply above this line<br>
==================================================</p>
<p><b>From</b>: lsegal (Support staff)</p>
<div>
<p>YARD does not generate the Book class locally either. I tried
this out on my machine and noticed at least one syntax error:</p>
<blockquote>
<p>[warn]: Syntax error in
<code>lib/robust_excel_ole/book.rb</code>:(700,25): syntax error,
unexpected ':', expecting keyword_then or ',' or ';' or '\n'</p>
</blockquote>
<p>This is likely the cause on rubydoc.info as well.</p>
</div>
<div>
<p>On Fri, Feb 05 at 09:29 AM PST, Thomas Raths wrote:</p>
<blockquote>
<div>
<div>Hello,</div>
<div>thanks a lot for you answer.</div>
<div> </div>
<div>
<p>>That said, if you want to preview, your documentation does
seem to work from the GitHub side of things:</p>
<p><a href=
"http://www.rubydoc.info/github/Thomas008/robust_excel_ole/master/RobustExcelOle/Excel#new-class_method">
>http://www.rubydoc.info/github/Thomas008/robust_excel_ole/master/Ro...</a></p>
</div>
<div>No, it does not work:</div>
<div>The problem is:</div>
<div>The class Book is not displayed.</div>
<div> </div>
<div>>Though I would suggest using YARD locally to test this, if
you're looking to preview documentation as you build it up.</div>
<div>I did it, and the class Book is here displayed.</div>
<div> </div>
<div>How can I let display the class Book?</div>
<div> </div>
<div>Thanks a lot,</div>
<div>Thomas</div>
<div> </div>
<div> </div>
<div><br>
</div>
<div class="signature">---<br>
Dr. Thomas Raths<br>
Körperpsychotherapie, Theatertherapie, Tanz<br>
<br>
Karmeliterweg 49<br>
13465 Berlin-Frohnau<br>
<br>
0175 - 90 81 668<br>
<a href=
"http://www.erlebens-raum.de">www.erlebens-raum.de</a></div>
<div>
<div>
<div>
<div><b>Gesendet:</b> Freitag, 29. Januar 2016 um 12:29
Uhr<br>
<b>Von:</b> lsegal <[email blocked]><br>
<b>An:</b> [email blocked]<br>
<b>Betreff:</b> Re: A class is missing in the documentation
[Problems #437]</div>
<div><!--pre { width: 92.0%; margin: 10.0px 2.0%; padding: 5.0px
2.0%; background: rgb(239,239,239); border: 1.0px solid
rgb(214,214,214); } blockquote { margin-left: 0; padding-left:
1.0em; border-left: 5.0px solid rgb(204,204,204); } -->
<table width="100%">
<tr>
<td>
<p>// Please reply above this line<br>
==================================================</p>
<p><b>From</b>: lsegal (Support staff)</p>
<div>
<p>I see that you <a href=
"https://github.com/Thomas008/robust_excel_ole/commit/aa32815ccb715d8f97e8b31eb08baa606bcd89d3">
recently added YARD formatted documentation in your source</a>, but
these additions seem to have come <em>after</em> your <a href=
"https://rubygems.org/gems/robust_excel_ole">last release
(v0.3.7)</a> (commit was in January 2016, release was December
2015). The gems portion of rubydoc.info only serves from released
gem code, so in order to see this under /gems/robust_excel_ole, you
must release a new version.</p>
<p>That said, if you want to preview, your documentation does seem
to work from the GitHub side of things:</p>
<p><a href=
"http://www.rubydoc.info/github/Thomas008/robust_excel_ole/master/RobustExcelOle/Excel#new-class_method">
http://www.rubydoc.info/github/Thomas008/robust_excel_ole/master/Ro...</a></p>
<p>Though I would suggest using YARD locally to test this, if
you're looking to preview documentation as you build it up.</p>
<p>Hope that helps!</p>
</div>
<div>
<p>On Thu, Jan 28 at 11:56 PM PST, Thomas Raths wrote:</p>
<blockquote>
<div>
<div>Thank you!</div>
<div>The link is</div>
<div><a href=
"http://www.rubydoc.info/gems/robust_excel_ole/0.3.7">http://www.rubydoc.info/gems/robust_excel_ole/0.3.7</a></div>
<div> </div>
<div>Thoams</div>
<div> </div>
<div class="signature">---<br>
Dr. Thomas Raths<br>
Körperpsychotherapie, Theatertherapie, Tanz<br>
<br>
Karmeliterweg 49<br>
13465 Berlin-Frohnau<br>
<br>
0175 - 90 81 668<br>
<a href=
"http://www.erlebens-raum.de">www.erlebens-raum.de</a></div>
<div>
<div>
<div>
<div><b>Gesendet:</b> Freitag, 29. Januar 2016 um 01:42
Uhr<br>
<b>Von:</b> lsegal <[email blocked]><br>
<b>An:</b> [email blocked]<br>
<b>Betreff:</b> Re: A class is missing in the documentation
[Problems #437]</div>
<div><!--pre { width: 92.0%; margin: 10.0px 2.0%; padding: 5.0px
2.0%; background: rgb(239,239,239); border: 1.0px solid
rgb(214,214,214); } blockquote { margin-left: 0; padding-left:
1.0em; border-left: 5.0px solid rgb(204,204,204); } -->
<table width="100%">
<tr>
<td>
<p>// Please reply above this line<br>
==================================================</p>
<p><b>From</b>: lsegal (Support staff)</p>
<div>
<p>Can you provide more information as to where you are not seeing
the documentation? A URL would be helpful.</p>
</div>
<div>
<p>On Sun, Jan 03 at 07:34 AM PST, wrote:</p>
<blockquote>
<div>
<p>We implemented a library "robust_excel_ole". There the class
Book is missing in the documentation.<br>
Do you have any suggestions?<br>
Thank you very much in advance.<br>
Thomas</p>
</div>
</blockquote>
</div>
</td>
</tr>
<tr>
<td>
<p>Having trouble reading this? View this discussion online:
<a href=
"https://rubydoc.tenderapp.com/discussions/problems/437-a-class-is-missing-in-the-documentation">
A class is missing in the documentation</a>.</p>
<p>Reply with #ignore to stop receiving notifications for this
discussion.</p>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
</blockquote>
</div>
</td>
</tr>
<tr>
<td>
<p>Having trouble reading this? View this discussion online:
<a href=
"https://rubydoc.tenderapp.com/discussions/problems/437-a-class-is-missing-in-the-documentation">
A class is missing in the documentation</a>.</p>
<p>Reply with #ignore to stop receiving notifications for this
discussion.</p>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
</blockquote>
</div>
</td>
</tr>
<tr>
<td>
<p>Having trouble reading this? View this discussion online:
<a href=
"https://rubydoc.tenderapp.com/discussions/problems/437-a-class-is-missing-in-the-documentation">
A class is missing in the documentation</a>.</p>
<p>Reply with #ignore to stop receiving notifications for this
discussion.</p>
</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>Thomas Rathstag:rubydoc.tenderapp.com,2010-12-26:Comment/388187492016-02-16T19:24:42Z2016-02-16T19:28:46ZA class is missing in the documentation<div><p>rubydoc.info uses the master branch of YARD, though that should
have no effect on this specific issue, which should be working
correctly in 0.8.7.6.</p>
<p>The important part is that YARD is run on Ruby 2.1.4 on the
site, which means it uses the new-style parser (not legacy unless
explicitly enabled). If you want to reproduce what YARD does on
rubydoc.info, you should be running on Ruby 2.x at least.</p>
<p>As an aside, you should probably not be using Ruby 1.8 for
developer tooling anymore. More relevantly, if you are releasing a
RubyGem, you should <em>absolutely</em> be authoring for Ruby 2.x,
which means you should be running your tests against Ruby 2.x as
well. The community has by and large moved away from 1.8, so if you
publish code that is not at least 1.9+ compatible, very few people
will be able to use it.</p>
<p>It still does not seem as though you have fixed the issue
described above or added the <code>--legacy</code> switch to your
<code>.yardopts</code> file (<a href="https://rubydoc.tenderapp.com/kb/getting-started-with-rubydocinfo/setting-up-a-yardopts-file">see
this KB article for setting up options</a>). I am pretty sure
that's why rubydoc is still not picking up the class. Note that
adding the <code>--legacy</code> switch is <em>not</em> the
preferred fix, changing the case/when syntax in your code is the
recommended path, since <strong>your library is currently broken
for anyone using Ruby 1.9+</strong>.</p></div>lsegal