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

update returns to render as yaml #40

Merged
merged 2 commits into from
Aug 8, 2024

Conversation

jriddle-linode
Copy link
Collaborator

📝 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
  1. Install the tool
make install
  1. Go to ansible_linode and use it on a module
ansible-specdoc -j -i plugins/modules/domain.py
  1. Open and view the file verfiying the format of the RETURN section

@jriddle-linode jriddle-linode requested a review from a team as a code owner August 5, 2024 16:48
@jriddle-linode jriddle-linode requested review from zliang-akamai and ezilber-akamai and removed request for a team August 5, 2024 16:48
@jriddle-linode jriddle-linode added the improvement for improvements in existing functionality in the changelog. label Aug 5, 2024
Copy link

@ezilber-akamai ezilber-akamai left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Followed the testing steps and the RETURN section looks good. Nice work!

@jriddle-linode jriddle-linode merged commit 7f3e92c into linode:main Aug 8, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement for improvements in existing functionality in the changelog.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants