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

Add filter documentation #99

Merged
merged 4 commits into from
Apr 30, 2022
Merged

Conversation

felixfontein
Copy link
Collaborator

SUMMARY

Add filter documentation using the new sidecar docs feature for ansible-core 2.13. Rendered with ansible-community/antsibull-docs#6 to: https://ansible.fontein.de/collections/community/dns/index.html#filter-plugins

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

filter plugin documentation

@codecov
Copy link

codecov bot commented Apr 30, 2022

Codecov Report

Merging #99 (15d904f) into main (aba3d3c) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main      #99   +/-   ##
=======================================
  Coverage   96.53%   96.54%           
=======================================
  Files          87       88    +1     
  Lines        6124     6131    +7     
  Branches      777      778    +1     
=======================================
+ Hits         5912     5919    +7     
  Misses        144      144           
  Partials       68       68           
Impacted Files Coverage Δ
plugins/doc_fragments/filters.py 100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update aba3d3c...15d904f. Read the comment docs.

Copy link
Contributor

@briantist briantist left a comment

Choose a reason for hiding this comment

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

Looks good to me! A lot of the options for these filters are duplicated. A doc fragment seems like it could be useful for these, assuming sidecar docs still support those (I would hope so). That can be another PR though.

Copy link
Contributor

@briantist briantist left a comment

Choose a reason for hiding this comment

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

cool, much cleaner with the doc fragment

@felixfontein felixfontein merged commit d827b89 into ansible-collections:main Apr 30, 2022
@felixfontein felixfontein deleted the docs branch April 30, 2022 15:36
@felixfontein
Copy link
Collaborator Author

@briantist thanks again for reviewing!

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

Successfully merging this pull request may close these issues.

2 participants