Improve examples formatting
SUMMARY
As was spotted in https://github.com/ansible-collections/community.rabbitmq/pull/73#discussion_r705131780, the format of the examples can be improved to
- name: Do something
community.rabbitmq.rabbitmq_module:
...
or if a task descr is long
- name: |-
Here is my very very long explanation of
what this task is doing and how and for what in details
community.rabbitmq.rabbitmq_module:
...
ISSUE TYPE
- Documentation Report
COMPONENT NAME
All the modules need to be checked
@abompard would you like to pick it up as we spotted this in your PR?
I have found the following files in modules where EXAMPLES can be formatted as mentioned here
- rabbitmq_vhost.py
- rabbitmq_global_parameter.py
- rabbitmq_vhost_limits.py
- rabbitmq_exchange.py
- rabbitmq_binding.py
- rabbitmq_queue.py
I would like to have permission to proceed with this task if possible.
@duttaANI hi and welcome to the project! I think @abompard has not started with this yet, so feel free to proceed! Thank you!
Yeah, thanks, I don't have much bandwidth for this at the moment unfortunately.
Should I also add r letter ? like EXAMPLES = r ''' .... ''' , after = symbol
Should I also add r letter ? like EXAMPLES = r ''' .... ''' , after = symbol
yes, please add this, thanks!