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.

Sign up for GitHub

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

Jump to bottom

Windows: Add "special" parameter types to docs #42853

Merged
merged 7 commits into from Jul 17, 2018
Merged

Windows: Add "special" parameter types to docs #42853

merged 7 commits into from Jul 17, 2018

Conversation

dagwieers
Copy link
Contributor

@dagwieers dagwieers commented Jul 16, 2018 •
edited

SUMMARY

Adding explicit parameter types now exposes this information in the
module documentation, and proves really helpful.

We only do this for non-string types as strings, mostly because strings
are implicit.

This PR also includes a few other changes:

  • Make copyright statements consistent
  • Use #Requires for explicit library imports
  • Fix wrong "string" parameter type (possible impact to behaviour)
  • Two changes to integration tests to survive slows CI
ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

Windows modules

ANSIBLE VERSION

v2.7

@dagwieers
Windows: Add special parameter types
18380a6 
Adding explicit parameter types now exposes this information in the
module documentation, and proves really helpful.

We only do this for non-string types as strings, mostly because strings
are implicit.

PS We also make copyright statements consistent and use #Requires for
explicit library imports
@dagwieers
Type "string" must be type "str"
d680860
@dagwieers dagwieers added the windows Windows community label Jul 16, 2018
@dagwieers
Copy link
Contributor Author

dagwieers commented Jul 16, 2018 •
edited

I would like to start deprecating support for WANT_JSON and POWERSHELL_COMMON in Ansible v2.7. And if possible, I would also like to clean up the older interface Get-Attr and start the deprecation process by Ansible v2.11.

@ansibot ansibot added affects_2.7 This issue/PR affects Ansible v2.7 docs This issue/PR relates to or includes documentation. needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jul 16, 2018
@dagwieers
Copy link
Contributor Author

dagwieers commented Jul 16, 2018 •
edited

@ansibot thinks this is a merge commit because of the sheer number of files.

bot_skip

@dagwieers dagwieers removed needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jul 16, 2018
@dagwieers dagwieers changed the title Windows: Add special parameter types Windows: Add "special" parameter types to documentation Jul 16, 2018
@dagwieers dagwieers changed the title Windows: Add "special" parameter types to documentation Windows: Add "special" parameter types to docs Jul 16, 2018
@dagwieers dagwieers added this to the 2.7.0 milestone Jul 16, 2018
@ansibot ansibot added needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jul 16, 2018
@dagwieers
Copy link
Contributor Author

Two more things I wasn't 100% sure about:

  • I removed # This file is part of Ansible because it wasn't common, but maybe we should add it everywhere instead ?
  • Some files do not have a Copyright statement, should we add # Copyright: (c) 2018, Ansible Project as is done for other files ?

@dagwieers dagwieers force-pushed the win-mods-docs branch 2 times, most recently from 9a04101 to 1d394d8 Compare July 16, 2018 21:35
@dagwieers dagwieers removed needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jul 17, 2018
@dagwieers dagwieers mentioned this pull request Jul 17, 2018
Merged
@nitzmahone nitzmahone merged commit 95a1170 into ansible:devel Jul 17, 2018
@ansible ansible locked and limited conversation to collaborators Jul 22, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@nitzmahone nitzmahone nitzmahone approved these changes

@jhawkesworth jhawkesworth jhawkesworth approved these changes

@jborean93 jborean93 jborean93 approved these changes

Assignees
No one assigned
Labels
affects_2.7 This issue/PR affects Ansible v2.7 docs This issue/PR relates to or includes documentation. windows Windows community
Projects
None yet
Milestone
2.7.0
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@dagwieers @nitzmahone @jhawkesworth @jborean93 @ansibot