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

fix doc for yum_repository.py. #59068

Merged
merged 5 commits into from
Jul 15, 2019
Merged

fix doc for yum_repository.py. #59068

merged 5 commits into from
Jul 15, 2019

Conversation

rnoma4696
Copy link
Contributor

The description has been replaced with proxy_password and proxy_username.

SUMMARY

The descreption has been replaced with proxy_password and proxy_username

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

ansible/lib/ansible/modules/packaging/os/yum_repository.py

ADDITIONAL INFORMATION

none

@rnoma4696
fix doc for yum_repository.py.
1aeb668 
The description has been replaced with proxy_password and proxy_username.
@ansibot
Copy link
Contributor

ansibot commented Jul 14, 2019

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

lib/ansible/modules/packaging/os/yum_repository.py:233:35: W291 trailing whitespace

click here for bot help

@ansibot
Copy link
Contributor

ansibot commented Jul 14, 2019

cc @jtyr
click here for bot help

@ansibot ansibot added affects_2.9 This issue/PR affects Ansible v2.9 ci_verified Changes made in this PR are causing tests to fail. docs This issue/PR relates to or includes documentation. 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. packaging Packaging category small_patch support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Jul 14, 2019
@rnoma4696
Delete white space
76e74f4 
Sorry! I wrote white spaces when I fix this file.
I deleted white spaces.
@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Jul 14, 2019
Akasurde
Akasurde requested changes Jul 15, 2019
View reviewed changes
Copy link
Member

@Akasurde Akasurde left a comment

Choose a reason for hiding this comment

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

@46gorilla Thanks for the contribution. Could you please add a changelog entry so that we can backport this PR ? You can find details about creating a changelog entry here? Ping me once you are done. Thanks.

@Akasurde Akasurde self-assigned this Jul 15, 2019
@Akasurde Akasurde removed the needs_triage Needs a first human triage before being processed. label Jul 15, 2019
@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 Jul 15, 2019
@rnoma4696
add changelog for PR 59068
7d19a54 
add changelog for PR 59068
@ansibot ansibot added support:community This issue/PR relates to code supported by the Ansible community. and removed small_patch labels Jul 15, 2019
@rnoma4696 @Akasurde
Update changelogs/fragments/59068-fix doc for yum_repository.py
55d5811 
Co-Authored-By: Abhijeet Kasurde <akasurde@redhat.com>
@rnoma4696
Copy link
Contributor Author

Please ask a question because I have little experience.
Does PR to fix a document need a changelog?
I have sent PR twice , but I didnt add changelog.
Is a change log "must" or "better" with PR to fix doc?

@Akasurde
Copy link
Member

@46gorilla Yes, changelog entry allows users to identify what changed in the given release. Since this is a documentation bug and will be backported, changelog entry is required.

Please rename changelog entry file to changelogs/fragments/59068-fix_doc_for_yum_repository.yml, currently it is changelogs/fragments/59068-fix doc for yum_repository.py.

@ansibot
Copy link
Contributor

ansibot commented Jul 15, 2019

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

changelogs/fragments/59068-fix doc for yum_repository.py:1:0: syntax-error invalid syntax (&lt;unknown&gt;, line 1)

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

changelogs/fragments/59068-fix doc for yum_repository.py:0:0: extension must be one of: .yml, .yaml

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

changelogs/fragments/59068-fix doc for yum_repository.py:1:9: SyntaxError: bugfixes:

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

changelogs/fragments/59068-fix doc for yum_repository.py:1:9: SyntaxError: bugfixes:

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

changelogs/fragments/59068-fix doc for yum_repository.py:1:9: SyntaxError: bugfixes:

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

changelogs/fragments/59068-fix doc for yum_repository.py:1:10: SyntaxError: bugfixes:

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

changelogs/fragments/59068-fix doc for yum_repository.py:1:10: SyntaxError: bugfixes:

The test ansible-test sanity --test compile --python 3.8 [explain] failed with 1 error:

changelogs/fragments/59068-fix doc for yum_repository.py:1:10: SyntaxError: bugfixes:

The test ansible-test sanity --test future-import-boilerplate [explain] failed with 1 error:

changelogs/fragments/59068-fix doc for yum_repository.py:0:0: missing: from __future__ import (absolute_import, division, print_function)

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

changelogs/fragments/59068-fix doc for yum_repository.py:0:0: missing: __metaclass__ = type

The test ansible-test sanity --test pep8 [explain] failed with 8 errors:

changelogs/fragments/59068-fix doc for yum_repository.py:2:1: E112 expected an indented block
changelogs/fragments/59068-fix doc for yum_repository.py:2:69: E211 whitespace before '('
changelogs/fragments/59068-fix doc for yum_repository.py:2:76: E231 missing whitespace after ':'
changelogs/fragments/59068-fix doc for yum_repository.py:2:77: E226 missing whitespace around arithmetic operator
changelogs/fragments/59068-fix doc for yum_repository.py:2:89: E226 missing whitespace around arithmetic operator
changelogs/fragments/59068-fix doc for yum_repository.py:2:97: E226 missing whitespace around arithmetic operator
changelogs/fragments/59068-fix doc for yum_repository.py:2:105: E226 missing whitespace around arithmetic operator
changelogs/fragments/59068-fix doc for yum_repository.py:2:110: E226 missing whitespace around arithmetic operator

click here for bot help

@ansibot ansibot added the ci_verified Changes made in this PR are causing tests to fail. label Jul 15, 2019
@rnoma4696
Copy link
Contributor Author

Thank you for answering.
And I renamed the changelog file.

@ansibot ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Jul 15, 2019
@Akasurde Akasurde merged commit 644eead into ansible:devel Jul 15, 2019
@rnoma4696 rnoma4696 deleted the fix_doc_for_proxy_user_and_password branch July 16, 2019 07:01
@ansible ansible locked and limited conversation to collaborators Aug 12, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Akasurde Akasurde Akasurde approved these changes

Assignees

@Akasurde Akasurde

Labels
affects_2.9 This issue/PR affects Ansible v2.9 docs This issue/PR relates to or includes documentation. 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. packaging Packaging category 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.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@rnoma4696 @ansibot @Akasurde