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 documentation for SONiC Ansible collection #394

Merged
merged 8 commits into from
Jun 12, 2024

Conversation

stalabi1
Copy link
Collaborator

@stalabi1 stalabi1 commented Jun 10, 2024

SUMMARY

I updated module documentation and removed extraneous regression facts reports

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

multiple modules

Checklist:
  • I have performed a self-review of my own code to ensure there are no formatting, linting, or security issues
  • I have verified that new and existing unit tests pass locally with my changes
  • I have not allowed coverage numbers to degenerate
  • I have maintained at least 90% code coverage
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works

@stalabi1 stalabi1 added the documentation Improvements or additions to documentation label Jun 10, 2024
@stalabi1 stalabi1 marked this pull request as ready for review June 10, 2024 21:55
@stalabi1 stalabi1 requested a review from kerry-meyer as a code owner June 10, 2024 21:55
@stalabi1 stalabi1 changed the title Update version added and remove extraneous facts reports Update documentation for SONiC Ansible collection Jun 11, 2024
Copy link
Collaborator

@kerry-meyer kerry-meyer left a comment

Choose a reason for hiding this comment

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

Thank you for providing these documentation and regression test formatting fixes.

I have posted three very minor corrections. All of the other changes look good.

plugins/modules/sonic_dhcp_snooping.py Outdated Show resolved Hide resolved
plugins/modules/sonic_l2_acls.py Outdated Show resolved Hide resolved
Copy link
Collaborator

@kerry-meyer kerry-meyer left a comment

Choose a reason for hiding this comment

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

Thank you for providing these corrections for our module documentation and helping to reduce the excess output from our regression testing.

The current set of proposed code revisions looks good.

Approved.

@kerry-meyer kerry-meyer merged commit c6bfcf1 into ansible-collections:main Jun 12, 2024
16 checks passed
@stalabi1 stalabi1 deleted the bug_fixes branch September 4, 2024 16:43
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants