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

Document the multiline prompt/answer format for ios commands #35716

Merged
merged 3 commits into from
Feb 5, 2018
Merged

Document the multiline prompt/answer format for ios commands #35716

merged 3 commits into from
Feb 5, 2018

Conversation

rcarrillocruz
Copy link
Contributor

SUMMARY

Document the multiline prompt/answer format for ios commands
Fixes #34468

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

ios_command

ANSIBLE VERSION
ansible 2.5.0 (document_multiline_ios_command 7060e58e5c) last updated 2018/02/05 10:11:56 (GMT +200)

@ansibot
Copy link
Contributor

ansibot commented Feb 5, 2018

The test ansible-test sanity --test ansible-doc --python 2.7 [?] failed with the following 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 [?] failed with the following 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.6 [?] failed with the following 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 [?] failed with the following 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 [?] failed with the following error:

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

click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Feb 5, 2018

cc @kedarX @privateip
click here for bot help

@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. docs_pull_request module This issue/PR relates to a module. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. 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 Feb 5, 2018
@gundalow gundalow self-assigned this Feb 5, 2018
@gundalow gundalow requested a review from acozine February 5, 2018 11:08
gundalow
gundalow requested changes Feb 5, 2018
View reviewed changes
Copy link
Contributor

@gundalow gundalow left a comment

Choose a reason for hiding this comment

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

Not valid note:

how about
1)

notes: 
  - Tested against IOS 15.6
  - If a command sent to the device requires answering a prompt, it is possible
    to express a command with the prompt expected and answer. See examples.

Then put in a full example in the EXAMPLE block.

Then also under commands's description: add a line something like
Supports C(prompt), see examples.

lib/ansible/modules/network/ios/ios_command.py Outdated
- If a command sent to the device requires answering a prompt, it is possible
to express a command with the prompt expected and answer in the following
manner:
ios_command:
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove this bit and moved to an example with a - name.

@gundalow
Copy link
Contributor

gundalow commented Feb 5, 2018

Also once we are happy with the example and wording we should add this to the other _command modules that support it.

@ansibot ansibot removed ci_verified Changes made in this PR are causing tests to fail. needs_triage Needs a first human triage before being processed. labels Feb 5, 2018
@ansibot
Copy link
Contributor

ansibot commented Feb 5, 2018

cc @Qalthos @Qalthos
click here for bot help

@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. owner_pr This PR is made by the module's maintainer. and removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Feb 5, 2018
@rcarrillocruz rcarrillocruz merged commit 875c134 into ansible:devel Feb 5, 2018
@ansibot ansibot added docs This issue/PR relates to or includes documentation. and removed docs_pull_request labels Mar 4, 2018
@dagwieers dagwieers added the ios Cisco IOS community label Feb 27, 2019
@dagwieers dagwieers added the cisco Cisco technologies label Feb 27, 2019
@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.
Reviewers

@gundalow gundalow gundalow approved these changes

@acozine acozine Awaiting requested review from acozine

Assignees

@gundalow gundalow

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 owner_pr This PR is made by the module's maintainer. support:network This issue/PR relates to code supported by the Ansible Network Team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

ios_commands documentation
4 participants
@rcarrillocruz @ansibot @gundalow @dagwieers