From 1639741fc898ac6192864d63fb4b078976fb2c84 Mon Sep 17 00:00:00 2001
From: Tahir Akhtar <tahir@indusvalleylabs.com>
Date: Tue, 3 Sep 2019 19:41:42 +0500
Subject: [PATCH] Clarity on mutual exclusion of Username and Token (#61668)
##### SUMMARY
Although there is an example showing that username is not required with personal access token, it will be nice to more clearly state in options description.
##### ISSUE TYPE
- Docs Pull Request
+label: docsite_pr
---
lib/ansible/modules/source_control/github_deploy_key.py | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/lib/ansible/modules/source_control/github_deploy_key.py b/lib/ansible/modules/source_control/github_deploy_key.py
index d36cc2bfe267c3..ec1871ddb3ab1d 100644
--- a/lib/ansible/modules/source_control/github_deploy_key.py
+++ b/lib/ansible/modules/source_control/github_deploy_key.py
@@ -57,10 +57,10 @@
default: 'no'
username:
description:
- - The username to authenticate with.
+ - The username to authenticate with. Should not be set when using personal access token
password:
description:
- - The password to authenticate with. A personal access token can be used here in place of a password.
+ - The password to authenticate with. Alternatively, a personal access token can be used instead of I(username) and I(password) combination.
token:
description:
- The OAuth2 token or personal access token to authenticate with. Mutually exclusive with I(password).