kewlfft / ansible-aur

Ansible module to manage packages from the AUR
GNU General Public License v3.0
299 stars 47 forks source link

Please add documentation to aur.py #6

Closed panchoh closed 6 years ago

panchoh commented 6 years ago

The documentation only exists on README.md.

When I try:

$ ansible-doc aur
ERROR! module aur missing documentation (or could not parse documentation): Parsing produced an empty object.

I use this a lot from my editor, to check the params of the modules without having to fire up a browser...

Thanks a bunch!

BTW, If you are busy with other stuff, I could try and do it and drop you a PR, but not immediately.

kewlfft commented 6 years ago

please have a look at the documentation added and let me know

panchoh commented 6 years ago

Perfect.

Very much appreciated.

kewlfft commented 6 years ago

If you can test it and let me know if everything is ok, I will release 0.20 in the coming hours

panchoh commented 6 years ago

I've battle tested it with my ansible installer, and it works like a charm. I've fixed a couple of minor things in the doc (#7), but besides those, it's golden.