Second layer defined functions seem not to be checked

[conrad-stork-basf]

Second layer defined functions seem not to be checked

[conrad-stork-basf]

Hi @conrad-stork-basf

For example one, I've decided that it goes against the expected behaviour. If the user was to want to skip an indented function they can prefix it with an underscore. That will now be a valid check by default after this merge, and has been Fixed

For example two, it is expected that the function is skipped, as it is not in the global scope and exists within the function as sort of a private function or class. I understand that yourself and your team (and other users) may want to document and check these too, so I've Added a new flag, -N/--check-nested. Please pass this flag after you've updated docsig to the latest release (or add it to your pyproject.toml to run this check by default)

I'll include these changes with v0.47.0 which should be available on PyPI when you see this.

Any issues please don't hesitate to open another issue

Thanks again! Stephen

Hi Stephen,

thanks a lot for the implementation. I have already tested it and it works like a charm. Also thanks for the additional flag, I think this completely makes sense.

If we have any other issues we will let you know, but at the moment everything is working very smooth!

Thanks again and Best
Conrad

[jshwi]

Hi @conrad-stork-basf

Thank you for taking the time to open this issue, I'm happy to hear you have found a use for this package, and I appreciate your interest in improving it

Docsig is pretty specific in what it does, but there's a lot of room for customisation. I'll review this issue, and the code you provided a little more, and I'll get back to you as soon as I can (once I have some additional info I can provide)

Cheers!
Stephen

[jshwi]

Hi @conrad-stork-basf

For example one, I've decided that it goes against the expected behaviour. If the user was to want to skip an indented function they can prefix it with an underscore. That will now be a valid check by default after this merge, and has been Fixed

For example two, it is expected that the function is skipped, as it is not in the global scope and exists within the function as sort of a private function or class. I understand that yourself and your team (and other users) may want to document and check these too, so I've Added a new flag, -N/--check-nested. Please pass this flag after you've updated docsig to the latest release (or add it to your pyproject.toml to run this check by default)

I'll include these changes with v0.47.0 which should be available on PyPI when you see this.

Any issues please don't hesitate to open another issue

Thanks again!
Stephen

[jshwi]

Great! Thanks for confirming @conrad-stork-basf 😃