From aeda12275cd4afa32e03a427bf94a9f3833caefa Mon Sep 17 00:00:00 2001 From: Jonas L Date: Thu, 31 Aug 2023 15:20:14 +0200 Subject: [PATCH] chore: add antsibull-docs lint-collection pre-commit hook (#315) ##### SUMMARY This check will run a linter against the documentation. I was already able to fix a few errors. --- .pre-commit-config.yaml | 11 +++++++++++ plugins/modules/hcloud_load_balancer_info.py | 2 +- plugins/modules/hcloud_load_balancer_target.py | 4 ++-- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 437d257..717c315 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -49,6 +49,17 @@ repos: - id: antsibull-changelog-lint - id: antsibull-changelog-lint-changelog-yaml + - repo: local + hooks: + - id: antsibull-docs-lint-collection + name: antsibull-docs lint-collection + description: Lint the collection docs + language: python + entry: antsibull-docs lint-collection-docs --plugin-docs . + pass_filenames: false + additional_dependencies: + - antsibull-docs==2.3.1 + - repo: https://github.com/ansible/ansible-lint rev: v6.18.0 hooks: diff --git a/plugins/modules/hcloud_load_balancer_info.py b/plugins/modules/hcloud_load_balancer_info.py index f8be7f8..370435e 100644 --- a/plugins/modules/hcloud_load_balancer_info.py +++ b/plugins/modules/hcloud_load_balancer_info.py @@ -134,7 +134,7 @@ hcloud_load_balancer_info: use_private_ip: description: - Route the traffic over the private IP of the Load Balancer through a Hetzner Cloud Network. - - Load Balancer needs to be attached to a network. See M(hetzner.hcloud.hcloud.hcloud_load_balancer_network) + - Load Balancer needs to be attached to a network. See M(hetzner.hcloud.hcloud_load_balancer_network) type: bool sample: true returned: always diff --git a/plugins/modules/hcloud_load_balancer_target.py b/plugins/modules/hcloud_load_balancer_target.py index 1b39497..2bddcbb 100644 --- a/plugins/modules/hcloud_load_balancer_target.py +++ b/plugins/modules/hcloud_load_balancer_target.py @@ -47,7 +47,7 @@ options: use_private_ip: description: - Route the traffic over the private IP of the Load Balancer through a Hetzner Cloud Network. - - Load Balancer needs to be attached to a network. See M(hetzner.hcloud.hcloud.hcloud_load_balancer_network) + - Load Balancer needs to be attached to a network. See M(hetzner.hcloud.hcloud_load_balancer_network) type: bool default: False state: @@ -129,7 +129,7 @@ hcloud_load_balancer_target: use_private_ip: description: - Route the traffic over the private IP of the Load Balancer through a Hetzner Cloud Network. - - Load Balancer needs to be attached to a network. See M(hetzner.hcloud.hcloud.hcloud_load_balancer_network) + - Load Balancer needs to be attached to a network. See M(hetzner.hcloud.hcloud_load_balancer_network) type: bool sample: true returned: always