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

Various module doc fixes #37256

Merged
merged 1 commit into from
Mar 12, 2018
Merged

Various module doc fixes #37256

merged 1 commit into from
Mar 12, 2018

Conversation

dagwieers
Copy link
Contributor

@dagwieers dagwieers commented Mar 9, 2018

SUMMARY

This PR includes:

  • A fix for multiple-choice defaults
  • A fix for messed up dictionary samples
  • Cleaner defaults when they don't appear part of choices

Missing choice before this PR
screenshot from 2018-03-09 16-17-19

Missing choice after this PR
screenshot from 2018-03-09 16-24-05

NOTE: This PR also fixes the module documentation to not use the default value as a free flow of text. We will have to add validation checks to avoid people abusing the default value.

Fixing the module docs, removing free text as default
screenshot from 2018-03-09 16-28-07

Multiple choices before this PR
screenshot from 2018-03-09 16-14-51

Multiple choice after this PR
screenshot from 2018-03-09 16-14-13

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

module docs

ANSIBLE VERSION

v2.5

@dagwieers dagwieers added this to the 2.5.0 milestone Mar 9, 2018
@dagwieers dagwieers added this to To Do in 2.5.x blocker list via automation Mar 9, 2018
@dagwieers dagwieers requested a review from gundalow March 9, 2018 14:59
@ansibot
Copy link
Contributor

ansibot commented Mar 9, 2018

@ansibot ansibot added bug This issue/PR relates to a bug. core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. module This issue/PR relates to a module. support:community This issue/PR relates to code supported by the Ansible community. support:core This issue/PR relates to code supported by the Ansible Engineering Team. windows Windows community labels Mar 9, 2018
This PR includes:
- A fix for multiple-choice defaults
- A fix for messed up dictionary samples
- Cleaner defaults when they don't appear part of choices
Copy link
Contributor

@dharmabumstead dharmabumstead left a comment

Choose a reason for hiding this comment

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

Thanks @dagwieers!

@dharmabumstead dharmabumstead merged commit 80ba7b7 into ansible:devel Mar 12, 2018
privateip added a commit that referenced this pull request Mar 13, 2018
nitzmahone pushed a commit that referenced this pull request Mar 16, 2018
This PR includes:
- A fix for multiple-choice defaults
- A fix for messed up dictionary samples
- Cleaner defaults when they don't appear part of choices
(cherry picked from commit 80ba7b7)
@nitzmahone
Copy link
Member

cherry picked to stable-2.5 for 2.5.0rc3

@nitzmahone nitzmahone moved this from To Do to Done in 2.5.x blocker list Mar 16, 2018
@ansible ansible locked and limited conversation to collaborators Apr 27, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug This issue/PR relates to a bug. core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. module This issue/PR relates to a module. support:community This issue/PR relates to code supported by the Ansible community. support:core This issue/PR relates to code supported by the Ansible Engineering Team. windows Windows community
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

5 participants