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

Clarify example for fileglob lookup plugin #54941

Merged
merged 1 commit into from
Apr 7, 2019
Merged

Clarify example for fileglob lookup plugin #54941

merged 1 commit into from
Apr 7, 2019

Conversation

maxwell-k
Copy link
Contributor

@maxwell-k maxwell-k commented Apr 6, 2019

SUMMARY

fileglob returns a list of paths it does not return file contents, as explained in latest notes. The file lookup retrieves file contents. This change clarifies the first example to make it clear a paths, not contents, are returned.

It also adds spaces around the lookup to avoid E206 from ansible-lint: "Variables should have spaces before and after: {{ var_name }}"

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

fileglob lookup plugin

+label: docsite_pr

fileglob returns a list of paths it does not return file contents, as explained in latest notes. The file lookup retrieves file contents. This change clarifies the first example to make it clear a paths, not contents, are returned. 

It also adds spaces around the lookup to avoid E206 from ansible-lint: "Variables should have spaces before and after: {{ var_name }}"

+label: docsite_pr
@ansibot ansibot added affects_2.8 This issue/PR affects Ansible v2.8 bug This issue/PR relates to a bug. community_review In order to be merged, this PR must follow the community review workflow. needs_triage Needs a first human triage before being processed. small_patch support:community This issue/PR relates to code supported by the Ansible community. docs This issue/PR relates to or includes documentation. labels Apr 6, 2019
@gundalow gundalow merged commit 889024e into ansible:devel Apr 7, 2019
@gundalow
Copy link
Contributor

gundalow commented Apr 7, 2019

@maxwell-k Thank you for this patch, making the docs clearer is always welcome.

@sivel sivel removed the needs_triage Needs a first human triage before being processed. label Apr 9, 2019
@maxwell-k maxwell-k deleted the patch-1 branch April 12, 2019 14:28
@ansible ansible locked and limited conversation to collaborators Jul 25, 2019
@dagwieers dagwieers added the docsite_pr This PR is created from documentation using the "Edit on GitHub" link. label Sep 5, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.8 This issue/PR affects Ansible v2.8 bug This issue/PR relates to a bug. community_review In order to be merged, this PR must follow the community review workflow. docs This issue/PR relates to or includes documentation. docsite_pr This PR is created from documentation using the "Edit on GitHub" link. small_patch support:community This issue/PR relates to code supported by the Ansible community.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants