Enhancement suggestion: Add capability to check __init__ document in its own docstring

[EFord36]

Enhancement suggestion: Add capability to check __init__ document in its own docstring

[jshwi]

Hello @EFord36

Thanks for taking the time to write this up, happy to hear you have found this useful

I went for the current format as this is how I like to write my class docstrings. I did consider the case you're making, but class checks were optional so I let it be. I can't remember what documentation or advice I followed for this to be my preferred way of writing class docstrings, but I can't argue with the PEP as I generally follow PEPs to reduce complexity in my workflow.

I would be interested in docsig supporting this. I would like this to benefit as many people as possible so if this is something anyone else would want, in this case yourself, then that would be reason enough to add it in my opinion.

I would like to keep the way classes are currently checked as an option, as myself and others (flask being an example) document classes this way as a preference

Please open a PR, that would be great! It could be as simple as creating a new flag, -C, --check-class-constructor and then implementing what you've suggested by passing the flag to the end logic. Personally I would prefer if this can work independent of the previous way. Although it wouldn't make much sense to pass -c and -C at the same time it doesn't really have to be an either or, and it could just be up to the end user to choose which switch they like. Adding string literal options to argparse can be a bit of a mess (e.g. docsig --check-class class or docsig --check-class constructor is probably not ideal, in my opinion, as it comes with the need to set defaults and just leads to more typing).

I look forward to seeing how things work out

Cheers!
Stephen

[EFord36]

Makes sense! Yes, totally makes sense that the flag is cleanest - I meant to mention that as an option as well, sorry for forgetting.

Hopefully I'll be able to get to this sometime next week!

[EFord36]

quick update - mainly for the purpose of saying 'I am working on this, it shouldn't be too long:

I've start working on this and think I'm nearly there implementation wise, but need to add tests (and to do that, figure out how to add tests that specify the options to docsig). Shouldn't take long, but I've been a bit tied up this week. Hopefully not too long until I can make some more progress.