community.rabbitmq icon indicating copy to clipboard operation
community.rabbitmq copied to clipboard

Improve examples formatting

Open Andersson007 opened this issue 4 years ago • 6 comments

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

Andersson007 avatar Sep 09 '21 09:09 Andersson007

@abompard would you like to pick it up as we spotted this in your PR?

Andersson007 avatar Sep 09 '21 09:09 Andersson007

I have found the following files in modules where EXAMPLES can be formatted as mentioned here

  1. rabbitmq_vhost.py
  2. rabbitmq_global_parameter.py
  3. rabbitmq_vhost_limits.py
  4. rabbitmq_exchange.py
  5. rabbitmq_binding.py
  6. rabbitmq_queue.py

I would like to have permission to proceed with this task if possible.

duttaANI avatar Sep 12 '21 09:09 duttaANI

@duttaANI hi and welcome to the project! I think @abompard has not started with this yet, so feel free to proceed! Thank you!

Andersson007 avatar Sep 13 '21 09:09 Andersson007

Yeah, thanks, I don't have much bandwidth for this at the moment unfortunately.

abompard avatar Sep 13 '21 09:09 abompard

Should I also add r letter ? like EXAMPLES = r ''' .... ''' , after = symbol

duttaANI avatar Sep 13 '21 11:09 duttaANI

Should I also add r letter ? like EXAMPLES = r ''' .... ''' , after = symbol

yes, please add this, thanks!

Andersson007 avatar Sep 13 '21 11:09 Andersson007