Skip to content

Commit

Permalink
Various Doc fixes (#53)
Browse files Browse the repository at this point in the history
* Various Doc fixes

* Check

* Put back

* Fix
  • Loading branch information
Andersson007 authored Jul 22, 2021
1 parent d85c886 commit e64a439
Show file tree
Hide file tree
Showing 8 changed files with 31 additions and 24 deletions.
5 changes: 3 additions & 2 deletions plugins/modules/proxysql_backend_servers.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
---
module: proxysql_backend_servers
author: "Ben Mildren (@bmildren)"
short_description: Adds or removes mysql hosts from proxysql admin interface.
short_description: Adds or removes mysql hosts from proxysql admin interface
description:
- The M(community.proxysql.proxysql_backend_servers) module adds or removes mysql hosts using
the proxysql admin interface.
Expand Down Expand Up @@ -99,7 +99,8 @@
extends_documentation_fragment:
- community.proxysql.proxysql.managing_config
- community.proxysql.proxysql.connectivity
notes:
- Supports C(check_mode).
'''

EXAMPLES = '''
Expand Down
5 changes: 3 additions & 2 deletions plugins/modules/proxysql_global_variables.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
---
module: proxysql_global_variables
author: "Ben Mildren (@bmildren)"
short_description: Gets or sets the proxysql global variables.
short_description: Gets or sets the proxysql global variables
description:
- The M(community.proxysql.proxysql_global_variables) module gets or sets the proxysql global
variables.
Expand All @@ -29,7 +29,8 @@
extends_documentation_fragment:
- community.proxysql.proxysql.managing_config
- community.proxysql.proxysql.connectivity
notes:
- Supports C(check_mode).
'''

EXAMPLES = '''
Expand Down
5 changes: 3 additions & 2 deletions plugins/modules/proxysql_manage_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
module: proxysql_manage_config
author: "Ben Mildren (@bmildren)"
short_description: Writes the proxysql configuration settings between layers.
short_description: Writes the proxysql configuration settings between layers
description:
- The M(community.proxysql.proxysql_global_variables) module writes the proxysql configuration
settings between layers. Currently this module will always report a
Expand Down Expand Up @@ -57,7 +57,8 @@
required: True
extends_documentation_fragment:
- community.proxysql.proxysql.connectivity
notes:
- Supports C(check_mode).
'''

EXAMPLES = '''
Expand Down
7 changes: 4 additions & 3 deletions plugins/modules/proxysql_mysql_users.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
---
module: proxysql_mysql_users
author: "Ben Mildren (@bmildren)"
short_description: Adds or removes mysql users from proxysql admin interface.
short_description: Adds or removes mysql users from proxysql admin interface
description:
- The M(community.proxysql.proxysql_mysql_users) module adds or removes mysql users using the
proxysql admin interface.
Expand Down Expand Up @@ -101,7 +101,8 @@
extends_documentation_fragment:
- community.proxysql.proxysql.managing_config
- community.proxysql.proxysql.connectivity
notes:
- Supports C(check_mode).
'''

EXAMPLES = '''
Expand Down Expand Up @@ -134,7 +135,7 @@

RETURN = '''
stdout:
description: The mysql user modified or removed from proxysql
description: The mysql user modified or removed from proxysql.
returned: On create/update will return the newly modified user, on delete
it will return the deleted record.
type: dict
Expand Down
13 changes: 7 additions & 6 deletions plugins/modules/proxysql_query_rules.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
---
module: proxysql_query_rules
author: "Ben Mildren (@bmildren)"
short_description: Modifies query rules using the proxysql admin interface.
short_description: Modifies query rules using the proxysql admin interface
description:
- The M(community.proxysql.proxysql_query_rules) module modifies query rules using the
proxysql admin interface.
Expand Down Expand Up @@ -61,12 +61,12 @@
match_digest:
description:
- Regular expression that matches the query digest. The dialect of
regular expressions used is that of re2 - https://github.com/google/re2
regular expressions used is that of re2 - U(https://github.com/google/re2).
type: str
match_pattern:
description:
- Regular expression that matches the query text. The dialect of regular
expressions used is that of re2 - https://github.com/google/re2
expressions used is that of re2 - U(https://github.com/google/re2).
type: str
negate_match_pattern:
description:
Expand Down Expand Up @@ -176,14 +176,15 @@
force_delete:
description:
- By default we avoid deleting more than one schedule in a single batch,
however if you need this behaviour and you're not concerned about the
however if you need this behaviour and you are not concerned about the
schedules deleted, you can set I(force_delete) to C(True).
type: bool
default: False
extends_documentation_fragment:
- community.proxysql.proxysql.managing_config
- community.proxysql.proxysql.connectivity
notes:
- Supports C(check_mode).
'''

EXAMPLES = '''
Expand Down Expand Up @@ -265,7 +266,7 @@

RETURN = '''
stdout:
description: The mysql user modified or removed from proxysql
description: The mysql user modified or removed from proxysql.
returned: On create/update will return the newly modified rule, in all
other cases will return a list of rules that match the supplied
criteria.
Expand Down
4 changes: 2 additions & 2 deletions plugins/modules/proxysql_query_rules_fast_routing.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,11 @@
schedules deleted, you can set I(force_delete) to C(True).
type: bool
default: False
notes:
- Supports C(check_mode).
extends_documentation_fragment:
- community.proxysql.proxysql.managing_config
- community.proxysql.proxysql.connectivity
notes:
- Supports C(check_mode).
'''

EXAMPLES = '''
Expand Down
7 changes: 4 additions & 3 deletions plugins/modules/proxysql_replication_hostgroups.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
module: proxysql_replication_hostgroups
author: "Ben Mildren (@bmildren)"
short_description: Manages replication hostgroups using the proxysql admin
interface.
interface
description:
- Each row in mysql_replication_hostgroups represent a pair of
writer_hostgroup and reader_hostgroup. ProxySQL will monitor the value of
Expand Down Expand Up @@ -43,7 +43,8 @@
extends_documentation_fragment:
- community.proxysql.proxysql.managing_config
- community.proxysql.proxysql.connectivity
notes:
- Supports C(check_mode).
'''

EXAMPLES = '''
Expand Down Expand Up @@ -79,7 +80,7 @@

RETURN = '''
stdout:
description: The replication hostgroup modified or removed from proxysql
description: The replication hostgroup modified or removed from proxysql.
returned: On create/update will return the newly modified group, on delete
it will return the deleted record.
type: dict
Expand Down
9 changes: 5 additions & 4 deletions plugins/modules/proxysql_scheduler.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
---
module: proxysql_scheduler
author: "Ben Mildren (@bmildren)"
short_description: Adds or removes schedules from proxysql admin interface.
short_description: Adds or removes schedules from proxysql admin interface
description:
- The M(community.proxysql.proxysql_scheduler) module adds or removes schedules using the
proxysql admin interface.
Expand Down Expand Up @@ -66,14 +66,15 @@
force_delete:
description:
- By default we avoid deleting more than one schedule in a single batch,
however if you need this behaviour and you're not concerned about the
however if you need this behaviour and you are not concerned about the
schedules deleted, you can set I(force_delete) to C(True).
type: bool
default: False
extends_documentation_fragment:
- community.proxysql.proxysql.managing_config
- community.proxysql.proxysql.connectivity
notes:
- Supports C(check_mode).
'''

EXAMPLES = '''
Expand Down Expand Up @@ -107,7 +108,7 @@

RETURN = '''
stdout:
description: The schedule modified or removed from proxysql
description: The schedule modified or removed from proxysql.
returned: On create/update will return the newly modified schedule, on
delete it will return the deleted record.
type: dict
Expand Down

0 comments on commit e64a439

Please sign in to comment.