lsegal/yard — Issue #428: Manually defined attribute writer method not showing up in docs
Author: myronmarston
Created: 2011-12-16 07:02:18+00:00
State: open

I've started documenting VCR using YARD. However, there are some methods that I can't get to show up in the generated docs _at all_.

Consider [this code](https://github.com/myronmarston/vcr/blob/3fbd40882dce9ae947b6da5447d13045272de61b/lib/vcr/configuration.rb#L105-112):

``` ruby
# The directory to write cassettes to and read them from.
attr_reader :cassette_library_dir

# Sets the directory to write cassettes to and read them from.
def cassette_library_dir=(cassette_library_dir)
@cassette_library_dir = cassette_library_dir
FileUtils.mkdir_p(cassette_library_dir) if cassette_library_dir
end
```

The `attr_reader` shows up in the documentation, but not the writer method. You can see the docs [here](http://rubydoc.info/github/myronmarston/vcr/master/VCR/Configuration). There are other similar methods in that file that have the same issue.

The really unfortunate thing is that I really don't care if the reader method is documented; that's just for my use to read the user's config setting. The writer method is the important one to document as that's what end users use.