Skip to content
New issue

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

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
Neurogami opened this issue Oct 21, 2011 · 3 comments
Open

Comments

@Neurogami
Copy link

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
Copy link

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
Copy link
Author

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

@Neurogami Neurogami reopened this Oct 23, 2011
@Neurogami
Copy link
Author

Grr. Accirdentally closed this. No warning prompt?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants