API docs are lacking

[wcooley]

The "API" section of the documentation is a bit thin. For example, vcr.request.Request only includes the __init__ method, not any of the properties or methods.

I presume this is because there are no docstrings in the missing methods and the "undoc-members" is not enabled in the autodoc default options. Knowing that the method exists and seeing the signature would be better than nothing, even if there aren't actual docstrings.

I think all that would need to be done is to add to conf.py:

autodoc_default_options = {
    'members': None,
    'undoc-members': None,
}

[neozenith]

Happy to accept a pull request if you have the time to assist with this

[neozenith]

I don't have the bandwidth to chase this one up sorry. Will accept PRs though.

[neozenith]

Actually, scratch that. I was added as a maintainer of the RTD project now and it's bugging me that this isn't sorted. I'll chase this up.

[neozenith]

This is getting addressed in #499