Received a write suggestion for a method in a class labelled :nodoc:

[dgmstuart]

http://www.docsdoctor.org/doc_methods/289768, the method in question is in a class labelled like this:

class Scanner # :nodoc:

I don't know if that's valid.

[hwhelchel]

I did as well. I'm subscribed to rails on Code Triage and each doc request I received was for a :nodoc: method internal to the Rails API.

Is this a ruby convention or just a Rails convention? If it is a ruby wide convention, when # :nodoc: is found annotating a module or class, we then ignore all instance and class methods within the module or class.

If it is a rails specific convention, we could make the setting configurable.

[schneems]

For Rails, methods and classes are :nodoc: if they're private. They can still have docs on top of that, but it means that as a Rails user you shouldn't directly use that method or class. I still like to document them (if i'm working with them) as Rails is large enough that maintainers need docs in addition to end users. This is a rails convention.

You're getting a lot because Rails has alot. We use YARD to parse docs, which I don't think understands :nodoc:.