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

Adjust docstring in workflow_job_template.py #15399

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from

Conversation

dbk-rabel
Copy link

Those two parameters are required and should be documented accordingly.

@github-actions github-actions bot added component:awx_collection issues related to the collection for controlling AWX community labels Jul 24, 2024
@djyasin
Copy link
Member

djyasin commented Jul 24, 2024

@dbk-rabel thank you for time! Would you mind filling out the PR template?

SUMMARY
ISSUE TYPE
  • Breaking Change
  • New or Enhanced Feature
  • Bug, Docs Fix or other nominal change
COMPONENT NAME
  • API
  • UI
  • Collection
  • CLI
  • Docs
  • Other
AWX VERSION

ADDITIONAL INFORMATION

Copy link

sonarcloud bot commented Jul 24, 2024

@dbk-rabel
Copy link
Author

dbk-rabel commented Jul 25, 2024

@djyasin sure.

SUMMARY

Docstring in workflow_job_template.py adjusted

The parameters name and type are required for workflow_nodes and should be documented accordingly.

ISSUE TYPE

Docs

COMPONENT NAME

collection

AWX VERSION

Irrelevant.

ADDITIONAL INFORMATION

I think there is more errors in the docs strings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community component:awx_collection issues related to the collection for controlling AWX
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants