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

docs: fix eda ruff docs linting #547

Merged
merged 1 commit into from
Feb 20, 2024
Merged

Conversation

alperenkose
Copy link
Collaborator

Description

Tox ruff checks in CI for EDA partner testing was failing due to required linting. This PR fixes the below error for this check to pass.

Motivation and Context

ruff checks was failing because of a blank line required after "Returns" section in docstrings.

ruff: commands[0]> ruff check --select ALL --ignore INP001 -q ../../extensions/eda/plugins
/home/runner/work/pan-os-ansible/pan-os-ansible/extensions/eda/plugins/event_source/logs.py:57:5: D413 [*] Missing blank line after last section ("Returns")
/home/runner/work/pan-os-ansible/pan-os-ansible/extensions/eda/plugins/event_source/logs.py:68:5: D413 [*] Missing blank line after last section ("Returns")
ruff: exit 1 (0.01 seconds) /home/runner/work/pan-os-ansible/pan-os-ansible/.github/workflows> ruff check --select ALL --ignore INP001 -q ../../extensions/eda/plugins pid=[18](https://github.com/PaloAltoNetworks/pan-os-ansible/actions/runs/7958993848/job/21725025183#step:4:19)35
ruff: FAIL ✖ in 2 seconds

How Has This Been Tested?

Tested locally with tox and on CI.

Types of changes

CI tox fix.

Checklist

  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes if appropriate.
  • All new and existing tests passed.

Copy link
Collaborator

@adambaumeister adambaumeister left a comment

Choose a reason for hiding this comment

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

Makes sense, that's what I saw as well

@alperenkose alperenkose merged commit a7c1e86 into develop Feb 20, 2024
16 checks passed
@alperenkose alperenkose deleted the fix-eda-ruff-docs-linting branch February 20, 2024 07:08
Copy link

🎉 This PR is included in version 2.20.0 🎉

The release is available on Ansible Galaxy and GitHub release

Posted by semantic-release bot

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants