search

mendicant-original / ruby

The Ruby Programming Language
http://www.ruby-lang.org/
Other
19 stars 8 forks source link

attr_* methods are private, but usage should be publically documented #20

Open Neurogami opened 13 years ago

Neurogami commented 13 years ago

The assorted attr_* method are marked as private in the Ruby source code, so rdoc does not include them in the generated API docs. However, they are not, strictly speaking, private methods that should not be called in user code, and their usage should appear in the generated rdoc files.

steveklabnik commented 13 years ago

I mean, they are private methods. They shouldn't be called in user code outside of an implementation of an Object.

With that said, I'm not opposed to documenting attr_* somehow, but it's certainly interesting.

Neurogami commented 13 years ago

I tried applied the :doc: directive in object.c but to no avail, perhaps I was doing it wrong.

Neurogami commented 13 years ago

Grr. Accirdentally closed this. No warning prompt?