From 223dab99ea0075c96bf5bd049d2a140de5b4a285 Mon Sep 17 00:00:00 2001
From: Abhijeet Kasurde <akasurde@redhat.com>
Date: Thu, 5 Sep 2019 17:09:59 +0530
Subject: [PATCH] gitlab_hook: Update documentation (#61837)

* Update docs for note_events

Fixes: #61833

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
---
 .../modules/source_control/gitlab_hook.py     | 25 ++++++++++---------
 1 file changed, 13 insertions(+), 12 deletions(-)

diff --git a/lib/ansible/modules/source_control/gitlab_hook.py b/lib/ansible/modules/source_control/gitlab_hook.py
index 39ed08c8071..a1ff274b559 100644
--- a/lib/ansible/modules/source_control/gitlab_hook.py
+++ b/lib/ansible/modules/source_control/gitlab_hook.py
@@ -40,7 +40,7 @@ options:
       - access_token
   project:
     description:
-      - Id or Full path of the project in the form of group/name
+      - Id or Full path of the project in the form of group/name.
     required: true
     type: str
   hook_url:
@@ -50,54 +50,55 @@ options:
     type: str
   state:
     description:
-      - When C(present) the hook will be updated to match the input or created if it doesn't exist. When C(absent) it will be deleted if it exists.
+      - When C(present) the hook will be updated to match the input or created if it doesn't exist.
+      - When C(absent) hook will be deleted if it exists.
     required: true
     default: present
     type: str
     choices: [ "present", "absent" ]
   push_events:
     description:
-      - Trigger hook on push events
+      - Trigger hook on push events.
     type: bool
     default: yes
   issues_events:
     description:
-      - Trigger hook on issues events
+      - Trigger hook on issues events.
     type: bool
     default: no
   merge_requests_events:
     description:
-      - Trigger hook on merge requests events
+      - Trigger hook on merge requests events.
     type: bool
     default: no
   tag_push_events:
     description:
-      - Trigger hook on tag push events
+      - Trigger hook on tag push events.
     type: bool
     default: no
   note_events:
     description:
-      - Trigger hook on note events
+      - Trigger hook on note events or when someone adds a comment.
     type: bool
     default: no
   job_events:
     description:
-      - Trigger hook on job events
+      - Trigger hook on job events.
     type: bool
     default: no
   pipeline_events:
     description:
-      - Trigger hook on pipeline events
+      - Trigger hook on pipeline events.
     type: bool
     default: no
   wiki_page_events:
     description:
-      - Trigger hook on wiki events
+      - Trigger hook on wiki events.
     type: bool
     default: no
   hook_validate_certs:
     description:
-      - Whether GitLab will do SSL verification when triggering the hook
+      - Whether GitLab will do SSL verification when triggering the hook.
     type: bool
     default: no
     aliases: [ enable_ssl_verification ]
@@ -105,7 +106,7 @@ options:
     description:
       - Secret token to validate hook messages at the receiver.
       - If this is present it will always result in a change as it cannot be retrieved from GitLab.
-      - Will show up in the X-GitLab-Token HTTP request header
+      - Will show up in the X-GitLab-Token HTTP request header.
     required: false
     type: str
 '''