Parameter and return value descriptions missing

's Avatar


18 Jan, 2016 03:07 PM

I just noticed @param information is not shown. Neither the type, nor the description is shown. Also, the return value description is missing (only its type is shown). Seems like this is actually a bug with the template used, and not just cosmetics, as these are a pretty integral part of an API.

  1. Support Staff 1 Posted by lsegal on 29 Jan, 2016 12:41 AM

    lsegal's Avatar

    Can you provide more information as to where you are not seeing the tags? A URL would be helpful.

  2. 2 Posted by Patrik Wenger on 30 Jan, 2016 01:31 PM

    Patrik Wenger's Avatar

    Okay, it seems like this only happens on the generated API documentation for released gems (not directly from github).

    Here's an example: What I expect is [1]. What I see is [2]. As you can see, in 2, the bullet lists for parameters and return value are missing.


    [1] [2]

  3. 3 Posted by Patrik Wenger on 31 Jan, 2016 12:14 PM

    Patrik Wenger's Avatar
  4. 4 Posted by Henrique Becker on 06 Jul, 2016 02:54 PM

    Henrique Becker's Avatar


    I think I'm having the same problem. I published a gem on (, and it had its documentation generated (

    If I go to the method BatchExperiment::batch (, I don't see the parameters and the return; but as can be seen there ( there exists documentation for the parameters and return.

    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".

    I'm doing something wrong? There's any extra evidence I can obtain for you?

    Henrique Becker

  5. Support Staff 5 Posted by lsegal on 06 Jul, 2016 10:14 PM

    lsegal's Avatar

    Henrique, seems like this was a temporal issue that got cached. There's more details on this mysterious bug in 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!

  6. lsegal closed this discussion on 06 Jul, 2016 10:14 PM.

Comments are currently closed for this discussion. You can start a new one.

Keyboard shortcuts


? Show this help
ESC Blurs the current field

Comment Form

r Focus the comment reply box
^ + ↩ Submit the comment

You can use Command ⌘ instead of Control ^ on Mac