search

Andersson007 / ansible_reviewer

script to automate finding common issues in pull requests
MIT License
2 stars 1 forks source link

no "notes" section, when there is a s Doc section inherited from a extends_documentation_fragment #1

Open carchi8py opened 3 years ago

carchi8py commented 3 years ago

Tried out the tool as your recommended some issue is the tool doesn't check the doc_fragments.

All our collection use the _extends_documentationfragment for comment notes, and params

So for instance this module while has no note https://github.com/ansible-collections/netapp/blob/master/ansible_collections/netapp/cloudmanager/plugins/modules/na_cloudmanager_aggregate.py#L22 Will inherited the note here https://github.com/ansible-collections/netapp/blob/master/ansible_collections/netapp/cloudmanager/plugins/doc_fragments/netapp.py

When the documentation is built.

You can see this here in the .rst file that ansible-build build-docs will generate. https://github.com/ansible-collections/netapp/wiki/na_cloudmanager_aggregate

Andersson007 commented 3 years ago

@carchi8py , very good spotted, thanks! will see what i can do