update returns to render as yaml - Githubissues

linode / ansible-specdoc

A utility for dynamically generating Ansible Collection documentation.

Apache License 2.0

2 stars 5 forks source link

update returns to render as yaml #40

Closed jriddle-linode closed 3 months ago

jriddle-linode commented 3 months ago

📝 Description

What does this PR do and why is this change necessary?

Replaces the existing return samples with a yaml style format which will render correctly on Galaxy.

✔️ How to Test

How do I run the relevant unit/integration tests?

make test

Install the tool
```
make install
```

Go to ansible_linode and use it on a module

ansible-specdoc -j -i plugins/modules/domain.py

Open and view the file verfiying the format of the RETURN section