From: Eric Hodel <drbrain@...7.net>
Date: 2011-11-03T04:48:01+09:00
Subject: [ruby-core:40679] Re: Relevant methods not appearing in RDoc

On Nov 1, 2011, at 5:38 PM, Andrew Grimm wrote:
> I asked a few people about just having all private methods appear on
> ruby-doc (i.e. use the "--all" switch) but the feeling is that it
> would end up too cluttered.  Worse, it would likely encourage people
> to use those private methods that really are meant to be private.

private as in "this is an implementation detail" is different from private as in "do not call with a receiver"

> I tried adding :doc: to the source code in object.c and re-creating
> the docs but it didn't work for me; maybe this is a Ruby-source only
> directive (or I'm just doing it wrong).  So, for the immediate future,
> these methods won't be appearing in the API docs. However it's a known
> problem and proper fix for it is being worked on.

Opting-in to documentation by sprinkling :doc: across various methods to fix ruby-doc.org doesn't feel like the right way to go, opting out by hiding implementation details feels better.