Home → Problems →

Inconsistent behavior of @private for published gem code vs. GitHub code

• Edit

schmch

04 Aug, 2013 04:42 AM

I have a gem (Kappa) that has been published on RubyGems (https://rubygems.org/gems/kappa/). The documentation for this gem is on rdoc.info in two different places:

1. From the official gem source: http://rdoc.info/gems/kappa/frames
   
2. From my source at GitHub: http://rdoc.info/github/schmich/kappa/frames

At this point, the source for the gem and my source on GitHub are nearly identical. However, notice that #1 shows many more classes than #2. The problem appears to be that #1 is not respecting my @private specifications.

Specifically, notice that Twitch::Configuration shows up in #1 but does not show up in #2. In both cases, this class is marked @private (see https://github.com/schmich/kappa/blob/v1.0.0/lib/kappa/configuratio...).

I have specified --no-private in my .yardopts (see https://github.com/schmich/kappa/blob/master/.yardopts).

According to support (http://rubydoc.tenderapp.com/kb/getting-started-with-rubydocinfo/wh...), it looks like this should just work.

If I can help, let me know.

Thanks & regards,
Chris

1. Support Staff 1 Posted by lsegal on 04 Aug, 2013 07:07 AM

   

   Hey there Chris,

   My initial guess, based on the fact that there is only one difference between GitHub and Gem repos, is that the .yardopts file is simply not in your .gem file that you pushed up to rubygems. That's the code we download and unzip to run YARD against. Looks like this is indeed the case, as it is not present in your .gemspec.

   • Edit

2. 2 Posted by Chris Schmich on 04 Aug, 2013 11:31 AM

   

   Loren,

   Thanks a bunch for the fast reply. You are right, that fixed it. It looks like I didn't read the documentation thoroughly enough (hah...).

   Also, thanks for your work on this project. I've really enjoyed using YARD!

   Chris

   • Edit

3. lsegal closed this discussion on 22 Sep, 2013 07:19 PM.