Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

Bunder does not suppress documentation of included gems #2073

Closed
drbrain opened this Issue Aug 22, 2012 · 1 comment

Comments

Projects
None yet
3 participants
Contributor

drbrain commented Aug 22, 2012

Bundler includes net-http-persistent in lib/bundler/vendor but does not suppress this directory when generating RDoc.

This results in old documentation showing up in ri:

$ ri Net::HTTP::Persistent
Net::HTTP::Persistent < Object

(from gem bundler-1.1.5)
------------------------------------------------------------------------------
Persistent connections for Net::HTTP

Since this code is not generally accessible by users the documentation should be suppressed by adding an empty .document file to lib/bundler/vendor.

Owner

indirect commented Aug 22, 2012

That's a good point. Thanks!

On Aug 21, 2012, at 5:40 PM, Eric Hodel notifications@github.com wrote:

Bundler includes net-http-persistent in lib/bundler/vendor but does not suppress this directory when generating RDoc.

This results in old documentation showing up in ri:

$ ri Net::HTTP::Persistent
Net::HTTP::Persistent < Object

(from gem bundler-1.1.5)

Persistent connections for Net::HTTP
Since this code is not generally accessible by users the documentation should be suppressed by adding an empty .document file to lib/bundler/vendor.


Reply to this email directly or view it on GitHub.

indirect added a commit that referenced this issue Nov 20, 2012

Merge pull request #2172 from rohit/suppress_vendor_docs
Suppress rdoc from generating docs for vendored code #2073

@rohit rohit closed this Nov 21, 2012

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment