Skip to content
This repository has been archived by the owner on Jun 13, 2024. It is now read-only.

Fix the docs for the inventory plugins. #103

Merged
merged 1 commit into from
May 21, 2020

Conversation

abadger
Copy link
Contributor

@abadger abadger commented May 20, 2020

Documenting the structure of the dictionary to pass in needs to be done
via suboptions rather than putting the structure directoly inside of the
toplevel option.

ISSUE TYPE
  • Bugfix Pull Request
  • Docs Pull Request
COMPONENT NAME

inventory plugins

ADDITIONAL INFORMATION

@geerlingguy Hey, I'm working on a schema for docs. These inventory plugins are doing things in a non-standard way and I'd like to get this fix applied so that I don't have to specialcase the code to get the documentation to show up on pages like this: https://docs.ansible.com/ansible/latest/plugins/inventory/k8s.html

Documenting the structure of the dictionary to pass in needs to be done
via suboptions rather than putting the structure directoly inside of the
toplevel option.
@codecov
Copy link

codecov bot commented May 20, 2020

Codecov Report

Merging #103 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #103   +/-   ##
=======================================
  Coverage   42.98%   42.98%           
=======================================
  Files           3        3           
  Lines         542      542           
  Branches      110      110           
=======================================
  Hits          233      233           
  Misses        266      266           
  Partials       43       43           

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 2f7b552...d9ece47. Read the comment docs.

Copy link
Collaborator

@geerlingguy geerlingguy left a comment

Choose a reason for hiding this comment

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

LGTM, test failures are unrelated.

@geerlingguy geerlingguy merged commit a519cee into ansible-collections:master May 21, 2020
@abadger abadger deleted the fix-docs branch May 29, 2020 03:02
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants