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

ios_command: Correct answer example and consolidate docs on command param. #40158

Merged
merged 4 commits into from
May 16, 2018
Merged

ios_command: Correct answer example and consolidate docs on command param. #40158

merged 4 commits into from
May 16, 2018

Conversation

tyler-8
Copy link
Contributor

@tyler-8 tyler-8 commented May 15, 2018 •
edited

…te to be in line with command docs.

SUMMARY

Fixes: #40016

c does not actually confirm a Cisco prompt. 'y' does. I verified this on legacy IOS 15.4.1 and IOS-XE 16.06.03.

I think the "Note" on the command parameter could go overlooked as it displays at the bottom of the parameters list when rendered with Sphinx. This puts it inline and clearly attached to what it is describing.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

ios_commands

ANSIBLE VERSION
ansible 2.6.0 (iosdocs 13498066c3) last updated 2018/05/15 11:09:22 (GMT -400)
  config file = None
  configured module search path = ['/Users/tyler8/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /Users/tyler8/projects/pycon18/ansible/lib/ansible
  executable location = /Users/tyler8/.local/share/virtualenvs/pycon18-CTYMJGfK/bin/ansible
  python version = 3.6.5 (default, Mar 30 2018, 06:41:53) [GCC 4.2.1 Compatible Apple LLVM 9.0.0 (clang-900.0.39.2)]
ADDITIONAL INFORMATION
N/A

@tyler-8 tyler-8 changed the title Correct answer example as 'c' cancels, not confirms. Moved command no… ios_commands: Correct answer example and consolidate docs on command param. May 15, 2018
@tyler-8 tyler-8 changed the title ios_commands: Correct answer example and consolidate docs on command param. ios_command: Correct answer example and consolidate docs on command param. May 15, 2018
@ansibot
Copy link
Contributor

ansibot commented May 15, 2018

cc @privateip @rcarrillocruz
click here for bot help

@ansibot ansibot added 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. needs_triage Needs a first human triage before being processed. networking Network category support:network This issue/PR relates to code supported by the Ansible Network Team. labels May 15, 2018
@ansibot
Copy link
Contributor

ansibot commented May 15, 2018

The test ansible-test sanity --test ansible-doc --python 2.6 [explain] failed with 1 error:

lib/ansible/modules/network/ios/ios_command.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 2.7 [explain] failed with 1 error:

lib/ansible/modules/network/ios/ios_command.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.5 [explain] failed with 1 error:

lib/ansible/modules/network/ios/ios_command.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.7 [explain] failed with 1 error:

lib/ansible/modules/network/ios/ios_command.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test ansible-doc --python 3.6 [explain] failed with 1 error:

lib/ansible/modules/network/ios/ios_command.py:0:0: has a documentation error formatting or is missing documentation.

The test ansible-test sanity --test docs-build [explain] failed with the error:

Command "/usr/bin/python test/sanity/code-smell/docs-build.py" returned exit status 1.
>>> Standard Error
Traceback (most recent call last):
  File "test/sanity/code-smell/docs-build.py", line 101, in <module>
    main()
  File "test/sanity/code-smell/docs-build.py", line 17, in main
    raise subprocess.CalledProcessError(sphinx.returncode, cmd, output=stdout, stderr=stderr)
subprocess.CalledProcessError: Command '['make', 'singlehtmldocs']' returned non-zero exit status 2.

The test ansible-test sanity --test yamllint [explain] failed with 1 error:

lib/ansible/modules/network/ios/ios_command.py:50:23: error DOCUMENTATION: syntax error: mapping values are not allowed here

The test ansible-test sanity --test validate-modules [explain] failed with 5 errors:

lib/ansible/modules/network/ios/ios_command.py:0:0: E324 Value for "default" from the argument_spec ('all') for "match" does not match the documentation (None)
lib/ansible/modules/network/ios/ios_command.py:0:0: E324 Value for "default" from the argument_spec (1) for "interval" does not match the documentation (None)
lib/ansible/modules/network/ios/ios_command.py:0:0: E324 Value for "default" from the argument_spec (10) for "retries" does not match the documentation (None)
lib/ansible/modules/network/ios/ios_command.py:0:0: E326 Value for "choices" from the argument_spec (['all', 'any']) for "match" does not match the documentation ([])
lib/ansible/modules/network/ios/ios_command.py:50:23: E302 DOCUMENTATION is not valid YAML

click here for bot help

@ansibot ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels May 15, 2018
@acozine acozine moved this from In progress to Supported Modules Maintenance in Ansible-maintained Collections Documentation May 15, 2018
@gundalow gundalow removed the needs_triage Needs a first human triage before being processed. label May 16, 2018
ganeshrn
ganeshrn approved these changes May 16, 2018
View reviewed changes
Copy link
Member

@ganeshrn ganeshrn left a comment

Choose a reason for hiding this comment

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

lgtm

@gundalow gundalow removed the request for review from juliedavila May 16, 2018 14:27
@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI. and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels May 16, 2018
@tyler-8
Copy link
Contributor Author

tyler-8 commented May 16, 2018

Fixed the docs output.

@ansibot ansibot removed the needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI. label May 16, 2018
@gundalow gundalow merged commit db4ae20 into ansible:devel May 16, 2018
Ansible-maintained Collections Documentation automation moved this from Supported Modules Maintenance to Done May 16, 2018
@tyler-8 tyler-8 deleted the iosdocs branch May 16, 2018 14:56
@acozine acozine moved this from Done to Needs Backport to 2.5 in Ansible-maintained Collections Documentation May 16, 2018
@acozine acozine moved this from Needs Backport to 2.5 to Done in Ansible-maintained Collections Documentation May 16, 2018
jacum pushed a commit to jacum/ansible that referenced this pull request Jun 26, 2018
@tyler-8
ios_command: Correct answer example and consolidate docs on command p…
a3c98d5 
…aram. (ansible#40158)

* Correct answer example as 'c' cancels, not confirms. Moved command note to be in line with command docs.

* Correct example to escape square brackets. Remove '\r' mention as it does not get passed correctly.

* Add carriage return example since it works with double quotes.

* Remove colon which was breaking docs rendering.
ilicmilan pushed a commit to ilicmilan/ansible that referenced this pull request Nov 7, 2018
@tyler-8 @ilicmilan
ios_command: Correct answer example and consolidate docs on command p…
b1a0e0e 
…aram. (ansible#40158)

* Correct answer example as 'c' cancels, not confirms. Moved command note to be in line with command docs.

* Correct example to escape square brackets. Remove '\r' mention as it does not get passed correctly.

* Add carriage return example since it works with double quotes.

* Remove colon which was breaking docs rendering.
@dagwieers dagwieers added ios Cisco IOS community cisco Cisco technologies labels Feb 23, 2019
@ansible ansible locked and limited conversation to collaborators May 16, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Qalthos Qalthos Qalthos approved these changes

@gundalow gundalow gundalow approved these changes

@ganeshrn ganeshrn ganeshrn approved these changes

Assignees
No one assigned
Labels
cisco Cisco technologies core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. ios Cisco IOS community module This issue/PR relates to a module. networking Network category support:network This issue/PR relates to code supported by the Ansible Network Team.
Projects
No open projects
Ansible-maintained Collections Docume...
  
Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

ios_command - run command that requires answering a prompt in Network modules
6 participants
@tyler-8 @ansibot @Qalthos @gundalow @ganeshrn @dagwieers