tag:rubydoc.tenderapp.com,2010-12-26:/discussions/problems/441-parameter-and-return-value-descriptions-missingRubydoc.info: Discussion 2016-07-06T22:14:34Ztag:rubydoc.tenderapp.com,2010-12-26:Comment/389460292016-01-29T00:41:53Z2016-01-29T00:41:53ZParameter and return value descriptions missing<div><p>Can you provide more information as to where you are not seeing
the tags? A URL would be helpful.</p></div>lsegaltag:rubydoc.tenderapp.com,2010-12-26:Comment/389460292016-01-30T13:31:35Z2016-01-30T13:31:38ZParameter and return value descriptions missing<div><p>Okay, it seems like this only happens on the generated API
documentation for released gems (not directly from github).</p>
<p>Here's an example: What I expect is [1]. What I see is [2]. As
you can see, in <a href="for%20API%20documentation%20for%20released%20gems">2</a>, the
bullet lists for parameters and return value are missing.</p>
<p>Thanks.</p>
<p>[1] <a href="http://www.rubydoc.info/github/paddor/cztop/CZTop/Message#routing_id%3D-instance_method">
http://www.rubydoc.info/github/paddor/cztop/CZTop/Message#routing_i...</a>
[2] <a href="http://www.rubydoc.info/gems/cztop/CZTop/Message#receive_from-class_method">
http://www.rubydoc.info/gems/cztop/CZTop/Message#receive_from-class...</a></p></div>Patrik Wengertag:rubydoc.tenderapp.com,2010-12-26:Comment/389460292016-01-31T12:14:53Z2016-01-31T12:14:55ZParameter and return value descriptions missing<div><p>Sorry, wrong link! [2] is actually <a href="http://www.rubydoc.info/gems/cztop/CZTop/Message#routing_id%3D-instance_method">
http://www.rubydoc.info/gems/cztop/CZTop/Message#routing_id%3D-inst...</a></p></div>Patrik Wengertag:rubydoc.tenderapp.com,2010-12-26:Comment/389460292016-07-06T14:54:31Z2016-07-06T14:54:33ZParameter and return value descriptions missing<div><p>Hi,</p>
<p>I think I'm having the same problem. I published a gem on
rubygems.org (<a href="https://rubygems.org/gems/batch_experiment/versions/2.1.2">https://rubygems.org/gems/batch_experiment/versions/2.1.2</a>),
and it had its documentation generated (<a href="http://www.rubydoc.info/gems/batch_experiment/2.1.2">http://www.rubydoc.info/gems/batch_experiment/2.1.2</a>).</p>
<p>If I go to the method BatchExperiment::batch (<a href="http://www.rubydoc.info/gems/batch_experiment/2.1.2/BatchExperiment#batch-class_method">http://www.rubydoc.info/gems/batch_experiment/2.1.2/BatchExperiment...</a>),
I don't see the parameters and the return; but as can be seen there
(<a href="https://github.com/henriquebecker91/masters/blob/d7b5c33ce927e7628fb0a1c7ff3b4d14cca04c29/codes/rb/batch_experiment/lib/batch_experiment.rb#L119">https://github.com/henriquebecker91/masters/blob/d7b5c33ce927e7628f...</a>)
there exists documentation for the parameters and return.</p>
<p>When I execute Yard locally the parameters and return are
generated without any warning/error (see annexed screenshot). The
output of "yard - v" on my local machine is "yard 0.8.7.6".</p>
<p>I'm doing something wrong? There's any extra evidence I can
obtain for you?</p>
<p>Greetings,<br>
Henrique Becker</p></div>Henrique Beckertag:rubydoc.tenderapp.com,2010-12-26:Comment/389460292016-07-06T22:14:33Z2016-07-06T22:14:33ZParameter and return value descriptions missing<div><p>Henrique, seems like this was a temporal issue that got cached.
There's more details on this mysterious bug in <a href="https://github.com/docmeta/rubydoc.info/issues/82">https://github.com/docmeta/rubydoc.info/issues/82</a>
but we've never narrowed down the root cause since I cannot
reliably reproduce it. It works now, though. Let us know if this
happens again!</p></div>lsegal