Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve examples formatting #95

Open
Andersson007 opened this issue Sep 9, 2021 · 6 comments
Open

Improve examples formatting #95

Andersson007 opened this issue Sep 9, 2021 · 6 comments
Labels
documentation Improvements or additions to documentation easyfix help wanted Extra attention is needed

Comments

@Andersson007
Copy link
Contributor

Andersson007 commented Sep 9, 2021

SUMMARY

As was spotted in #73 (comment),
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 Andersson007 added documentation Improvements or additions to documentation easyfix and removed easyfix labels Sep 9, 2021
@Andersson007
Copy link
Contributor Author

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

@Andersson007 Andersson007 added the help wanted Extra attention is needed label Sep 9, 2021
@duttaANI
Copy link
Contributor

duttaANI commented Sep 12, 2021

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.

@Andersson007
Copy link
Contributor Author

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

@abompard
Copy link
Contributor

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

@duttaANI
Copy link
Contributor

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

@Andersson007
Copy link
Contributor Author

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

yes, please add this, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation easyfix help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants