From 1e0c582b9811f4923af36a7ab7fd3f43bf0b8d49 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Sat, 28 Dec 2024 16:52:27 +0100 Subject: [PATCH] Improve formulations. --- plugins/cliconf/routeros.py | 2 +- plugins/doc_fragments/api.py | 2 +- plugins/modules/api.py | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/plugins/cliconf/routeros.py b/plugins/cliconf/routeros.py index 1c3288f4..dc2f4a9a 100644 --- a/plugins/cliconf/routeros.py +++ b/plugins/cliconf/routeros.py @@ -10,7 +10,7 @@ name: routeros short_description: Use routeros cliconf to run command on MikroTik RouterOS platform description: - - This routeros plugin provides low level abstraction apis for sending and receiving CLI commands from MikroTik RouterOS + - This routeros plugin provides low level abstraction APIs for sending and receiving CLI commands from MikroTik RouterOS network devices. """ diff --git a/plugins/doc_fragments/api.py b/plugins/doc_fragments/api.py index edef5f09..5b0b411c 100644 --- a/plugins/doc_fragments/api.py +++ b/plugins/doc_fragments/api.py @@ -43,7 +43,7 @@ class ModuleDocFragment(object): - ssl port: description: - - RouterOS api port. If O(tls) is set, port will apply to TLS/SSL connection. + - RouterOS API port. If O(tls) is set, port will apply to TLS/SSL connection. - Defaults are V(8728) for the HTTP API, and V(8729) for the HTTPS API. type: int force_no_cert: diff --git a/plugins/modules/api.py b/plugins/modules/api.py index ecd99e01..404569d8 100644 --- a/plugins/modules/api.py +++ b/plugins/modules/api.py @@ -14,7 +14,7 @@ short_description: Ansible module for RouterOS API description: - Ansible module for RouterOS API with the Python C(librouteros) library. - - This module can add, remove, update, query and execute arbitrary command in RouterOS via API. + - This module can add, remove, update, query, and execute arbitrary command in RouterOS through the API. notes: - O(add), O(remove), O(update), O(cmd), and O(query) are mutually exclusive. - Use the M(community.routeros.api_modify) and M(community.routeros.api_find_and_modify) modules for more specific modifications, @@ -37,7 +37,7 @@ path: description: - Main path for all other arguments. - - If other arguments are not set, api will return all items in selected path. + - If other arguments are not set, the module will return all items in selected path. - Example V(ip address). Equivalent of RouterOS CLI C(/ip address print). required: true type: str @@ -57,7 +57,7 @@ update: description: - Update config/value in RouterOS by '.id' in selected path. - - Example V(.id=*03 address=1.1.1.3/32) and path V(ip address) will replace existing ip address with C(.id=*03). + - Example V(.id=*03 address=1.1.1.3/32) and path V(ip address) will replace the existing IP address with C(.id=*03). - Equivalent in RouterOS CLI C(/ip address set address=1.1.1.3/32 numbers=1). - Note C(number) in RouterOS CLI is different from C(.id). type: str @@ -261,7 +261,7 @@ RETURN = r""" message: - description: All outputs are in list with dictionary elements returned from RouterOS api. + description: All outputs are in list with dictionary elements returned from RouterOS API. sample: - address: 1.2.3.4 - address: 2.3.4.5