page is showing old docs with new(ish) version #

's Avatar

eli

18 Jan, 2019 01:44 AM

Hi. Today I released version 5.5.0 of the gem "ldclient-rb". Then, a bit later, I released a patch: 5.5.1.

In the past, the generated docs have been available quickly. However, what I'm currently seeing at [https://www.rubydoc.info/gems/ldclient-rb] is a bit weird. It says "5.5.0" at the top of the page, but the rest of the page seems to be old documentation from version 5.4.3 (this is immediately apparent because it's missing a bunch of stuff I added in 5.5.0, and it's showing stuff that I marked as @private). I see the same thing if I go to [https://www.rubydoc.info/gems/ldclient-rb/5.5.0].

Also, it's not acknowledging the 5.5.1 release at all - the index page [https://www.rubydoc.info/find/gems?q=ldclient] shows 5.5.0 as the latest. But RubyGems definitely has it: https://rubygems.org/gems/ldclient-rb

I'll check again tomorrow in case this is a transient problem.

  1. Support Staff 1 Posted by lsegal on 18 Jan, 2019 03:20 AM

    lsegal's Avatar

    It seems to be showing 5.5.1 in the breadcrumb now. Can you confirm that it's displaying the right docs?

  2. 2 Posted by Eli Bishop on 18 Jan, 2019 07:03 PM

    Eli Bishop's Avatar

    Yes and no. The right-hand frame, which shows the breadcrumb and the Readme
    file, is now up to date. Unfortunately, the left-hand frame with the list
    of modules and classes is still showing what appears to be the 5.4.3
    documentation: for instance, the SSE module and all of its classes were
    completely removed in v5.5.0, but they're still showing in that list.

    It does seem to have processed the new content when it comes to displaying
    individual pages. For instance, if I click on "SSE" in the list, I get a
    "not found" page, suggesting that it really has been removed— just not from
    the list. And if I click on other classes that haven't been removed, I do
    see up-to-date docs for them in the right-hand frame.

  3. Support Staff 3 Posted by lsegal on 18 Jan, 2019 07:08 PM

    lsegal's Avatar

    I just dumped some cache and it seems to be cleared up now. Let us know if you have any other issues!

  4. 4 Posted by Eli Bishop on 18 Jan, 2019 07:13 PM

    Eli Bishop's Avatar

    That's a lot better, thanks. I'm no longer seeing any old content.

    However— and this is probably not related at all, but since I've already
    got you— what I'm seeing is not exactly what I would expect from YARD.
    There are a lot of classes that are implementation details and we'd rather
    not have them cluttering up the docs, so, starting with 5.5.0, we tagged
    them as @private. I proofed all this stuff by running YARD locally prior to
    release, and those things were correctly omitted. But they're all still
    showing up on your site. I presume this means you're running YARD with
    different parameters than I was, but is there any way we can get the
    desired result?

  5. Support Staff 5 Posted by lsegal on 18 Jan, 2019 07:19 PM

    lsegal's Avatar

    You'll want to use a .yardopts file in your repository, and for RubyGems in particular, you will want to make sure the file is packaged with the .gem (included as part of spec.files): https://rubydoc.tenderapp.com/kb/getting-started-with-rubydocinfo/s...

    If you were testing this on the command line you probably were using --no-private, which is one of the options you would want in the .yardopts file. You can take a look at YARD's for an example: https://github.com/lsegal/yard/blob/master/.yardopts

  6. 6 Posted by Eli Bishop on 18 Jan, 2019 07:27 PM

    Eli Bishop's Avatar

    Great, thanks.

  7. 7 Posted by Eli Bishop on 18 Jan, 2019 07:45 PM

    Eli Bishop's Avatar

    Sorry, one more question. When I run YARD locally, in order for Markdown
    formatting to work I have to specify "--markup markdown" and
    "--markup-provider redcarpet". But since things did show up correctly on
    your site even without having a .yardopts file, it seems like maybe it
    works anyway in the default configuration. Should I omit those parameters?

  8. 8 Posted by Eli Bishop on 18 Jan, 2019 09:12 PM

    Eli Bishop's Avatar

    I'm pretty sure the answer to my last question is yes, so I added the .yardopts file and released version 5.5.2.

    However, I think there may still be some kind of caching problem happening, the same as before. That is, when I view [https://www.rubydoc.info/gems/ldclient-rb] I see the correct 5.5.2 content in the right-hand frame; and if I view a page like [https://www.rubydoc.info/gems/ldclient-rb/LaunchDarkly] it is correctly omitting stuff that was marked @private (for instance, the Impl module); but the list in the left-hand frame seems to be showing content for 5.5.1 or 5.5.0.

  9. Support Staff 9 Posted by lsegal on 18 Jan, 2019 09:17 PM

    lsegal's Avatar

    We've been having some update issues with gems recently-- I've force a refresh on this one and it should be updated to 5.5.2 everywhere now. I'll take a look at some of this refresh logic to see what's going on-- thanks for calling this out!

  10. 10 Posted by Eli Bishop on 18 Jan, 2019 09:27 PM

    Eli Bishop's Avatar

    Looks perfect now, thanks!

  11. lsegal closed this discussion on 19 Jan, 2019 06:03 AM.

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

Keyboard shortcuts

Generic

? 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