Docs: change yes/no to true/false (#480) (#481)

(cherry picked from commit 3ff1fad5f3)

plugins/modules/mysql_db.py

@@ -53,12 +53,12 @@ options:
     description:
     - Execute the dump in a single transaction.
     type: bool
-    default: no
+    default: false
   quick:
     description:
     - Option used for dumping large tables.
     type: bool
-    default: yes
+    default: true
   ignore_tables:
     description:
     - A list of table names that will be ignored in the dump
@@ -70,14 +70,14 @@ options:
     description:
     - Dump binary columns using hexadecimal notation.
     type: bool
-    default: no
+    default: false
     version_added: '0.1.0'
   force:
     description:
     - Continue dump or import even if we get an SQL error.
     - Used only when I(state) is C(dump) or C(import).
     type: bool
-    default: no
+    default: false
     version_added: '0.1.0'
   master_data:
     description:
@@ -96,7 +96,7 @@ options:
     description:
       - Skip locking tables for read. Used when I(state=dump), ignored otherwise.
     type: bool
-    default: no
+    default: false
     version_added: '0.1.0'
   dump_extra_args:
     description:
@@ -110,7 +110,7 @@ options:
       - If C(yes), the module will internally execute commands via a shell.
       - Used when I(state=import), ignored otherwise.
     type: bool
-    default: no
+    default: false
     version_added: '0.1.0'
   unsafe_login_password:
     description:
@@ -121,7 +121,7 @@ options:
       - Used only when I(state) is C(import) or C(dump) and
         I(login_password) is passed, ignored otherwise.
     type: bool
-    default: no
+    default: false
     version_added: '0.1.0'
   restrict_config_file:
     description:
@@ -132,14 +132,14 @@ options:
         under the hood that read named option file in addition to usual option files.
       - If this behavior is undesirable, use C(yes) to read only named option file.
     type: bool
-    default: no
+    default: false
     version_added: '0.1.0'
   check_implicit_admin:
     description:
       - Check if mysql allows login as root/nopassword before trying supplied credentials.
       - If success, passed I(login_user)/I(login_password) will be ignored.
     type: bool
-    default: no
+    default: false
     version_added: '0.1.0'
   config_overrides_defaults:
     description:
@@ -148,7 +148,7 @@ options:
       - Used when I(stat) is C(present) or C(absent), ignored otherwise.
       - It needs Python 3.5+ as the default interpreter on a target host.
     type: bool
-    default: no
+    default: false
     version_added: '0.1.0'
 
 seealso:
@@ -215,7 +215,7 @@ EXAMPLES = r'''
     name: my_db
     state: import
     target: /tmp/dump.sql.bz2
-    force: yes
+    force: true
 
 - name: Dump multiple databases
   community.mysql.mysql_db:
@@ -287,7 +287,7 @@ EXAMPLES = r'''
 
 - name: Try to create database as root/nopassword first. If not allowed, pass the credentials
   community.mysql.mysql_db:
-    check_implicit_admin: yes
+    check_implicit_admin: true
     login_user: bob
     login_password: 123456
     name: bobdata

plugins/modules/mysql_info.py

@@ -42,7 +42,7 @@ options:
     description:
     - Includes names of empty databases to returned dictionary.
     type: bool
-    default: no
+    default: false
 
 notes:
 - Calculating the size of a database might be slow, depending on the number and size of tables in it.
@@ -96,14 +96,14 @@ EXAMPLES = r'''
     filter: "!settings,!users"
 
 - name: Collect info about databases and version using ~/.my.cnf as a credential file
-  become: yes
+  become: true
   community.mysql.mysql_info:
     filter:
     - databases
     - version
 
 - name: Collect info about databases and version using ~alice/.my.cnf as a credential file
-  become: yes
+  become: true
   community.mysql.mysql_info:
     config_file: /home/alice/.my.cnf
     filter:
@@ -111,13 +111,13 @@ EXAMPLES = r'''
     - version
 
 - name: Collect info about databases including empty and excluding their sizes
-  become: yes
+  become: true
   community.mysql.mysql_info:
     config_file: /home/alice/.my.cnf
     filter:
     - databases
     exclude_fields: db_size
-    return_empty_dbs: yes
+    return_empty_dbs: true
 '''
 
 RETURN = r'''

plugins/modules/mysql_query.py

@@ -27,7 +27,7 @@ options:
       the state has been changed even if it has not. If it is important in your
       workflow, use the C(PyMySQL) connector instead.
     type: raw
-    required: yes
+    required: true
   positional_args:
     description:
     - List of values to be passed as positional arguments to the query.
@@ -46,7 +46,7 @@ options:
     description:
     - Where passed queries run in a single transaction (C(yes)) or commit them one-by-one (C(no)).
     type: bool
-    default: no
+    default: false
 seealso:
 - module: community.mysql.mysql_db
 author:
@@ -87,7 +87,7 @@ EXAMPLES = r'''
     query:
     - INSERT INTO articles (id, story) VALUES (2, 'my_long_story')
     - INSERT INTO prices (id, price) VALUES (123, '100.00')
-    single_transaction: yes
+    single_transaction: true
 '''
 
 RETURN = r'''

plugins/modules/mysql_replication.py

@@ -188,7 +188,7 @@ options:
     description:
     - Fails on error when calling mysql.
     type: bool
-    default: False
+    default: false
     version_added: '0.1.0'
 
 notes:
@@ -267,12 +267,12 @@ EXAMPLES = r'''
   community.mysql.mysql_replication:
     mode: startreplica
     connection_name: primary-1
-    fail_on_error: yes
+    fail_on_error: true
 
 - name: Change primary and fail on error (like when replica thread is running)
   community.mysql.mysql_replication:
     mode: changeprimary
-    fail_on_error: yes
+    fail_on_error: true
 
 '''
 

plugins/modules/mysql_role.py

@@ -53,7 +53,7 @@ options:
       - Append the privileges defined by the I(priv) option to the existing ones
         for this role instead of overwriting them.
     type: bool
-    default: no
+    default: false
 
   members:
     description:
@@ -71,7 +71,7 @@ options:
         for this role instead of overwriting them.
       - Mutually exclusive with the I(detach_members) and I(admin) option.
     type: bool
-    default: no
+    default: false
 
   detach_members:
     description:
@@ -79,7 +79,7 @@ options:
         instead of overwriting all the current members.
       - Mutually exclusive with the I(append_members) and I(admin) option.
     type: bool
-    default: no
+    default: false
 
   set_default_role_all:
     description:
@@ -87,7 +87,7 @@ options:
       - If C(yes), runs B(SET DEFAULT ROLE ALL TO) each of the I(members) when changed.
       - If you want to avoid this behavior, set this option to C(no) explicitly.
     type: bool
-    default: yes
+    default: true
 
   state:
     description:
@@ -103,7 +103,7 @@ options:
       - Check if mysql allows login as root/nopassword before trying supplied credentials.
       - If success, passed I(login_user)/I(login_password) will be ignored.
     type: bool
-    default: no
+    default: false
 
 notes:
   - Pay attention that the module runs C(SET DEFAULT ROLE ALL TO)
@@ -165,7 +165,7 @@ EXAMPLES = r'''
     members:
     - 'alice@%'
     - 'bob@%'
-    set_default_role_all: no
+    set_default_role_all: false
 
 # Assuming that the role developers exists,
 # add john to the current members
@@ -173,7 +173,7 @@ EXAMPLES = r'''
   community.mysql.mysql_role:
     name: developers
     state: present
-    append_members: yes
+    append_members: true
     members:
     - 'joe@localhost'
 
@@ -192,7 +192,7 @@ EXAMPLES = r'''
     name: readers
     state: present
     priv: 'fiction.*:UPDATE'
-    append_privs: yes
+    append_privs: true
 
 - name: Create role with the 'SELECT' and 'UPDATE' privileges in db1 and db2
   community.mysql.mysql_role:
@@ -208,7 +208,7 @@ EXAMPLES = r'''
     name: readers
     members:
     - 'joe@localhost'
-    detach_members: yes
+    detach_members: true
 
 - name: Remove the role readers if exists
   community.mysql.mysql_role:

plugins/modules/mysql_user.py

@@ -29,7 +29,7 @@ options:
     description:
       - Indicate that the 'password' field is a `mysql_native_password` hash.
     type: bool
-    default: no
+    default: false
   host:
     description:
       - The 'host' part of the MySQL username.
@@ -41,7 +41,7 @@ options:
         to all hostnames for a given user.
       - This option cannot be used when creating users.
     type: bool
-    default: no
+    default: false
   priv:
     description:
       - "MySQL privileges string in the format: C(db.table:priv1,priv2)."
@@ -66,7 +66,7 @@ options:
       - Append the privileges defined by priv to the existing ones for this
         user instead of overwriting existing ones.
     type: bool
-    default: no
+    default: false
   tls_requires:
     description:
       - Set requirement for secure transport as a dictionary of requirements (see the examples).
@@ -79,7 +79,7 @@ options:
     description:
       - Whether binary logging should be enabled or disabled for the connection.
     type: bool
-    default: yes
+    default: true
   state:
     description:
       - Whether the user should exist.
@@ -92,7 +92,7 @@ options:
       - Check if mysql allows login as root/nopassword before trying supplied credentials.
       - If success, passed I(login_user)/I(login_password) will be ignored.
     type: bool
-    default: no
+    default: false
   update_password:
     description:
       - C(always) will update passwords if they differ. This affects I(password) and the combination of I(plugin), I(plugin_hash_string), I(plugin_auth_string).
@@ -164,7 +164,7 @@ EXAMPLES = r'''
 - name: Removes all anonymous user accounts
   community.mysql.mysql_user:
     name: ''
-    host_all: yes
+    host_all: true
     state: absent
 
 - name: Create database user with name 'bob' and password '12345' with all database privileges
@@ -178,7 +178,7 @@ EXAMPLES = r'''
   community.mysql.mysql_user:
     name: bob
     password: '*EE0D72C1085C46C5278932678FBE2C6A782821B4'
-    encrypted: yes
+    encrypted: true
     priv: '*.*:ALL'
     state: present
 
@@ -249,7 +249,7 @@ EXAMPLES = r'''
     If mysql allows root/nopassword login, try it without the credentials first.
     If it's not allowed, pass the credentials
   community.mysql.mysql_user:
-    check_implicit_admin: yes
+    check_implicit_admin: true
     login_user: root
     login_password: 123456
     name: sally
@@ -258,7 +258,7 @@ EXAMPLES = r'''
 - name: Ensure no user named 'sally' exists at all
   community.mysql.mysql_user:
     name: sally
-    host_all: yes
+    host_all: true
     state: absent
 
 - name: Specify grants composed of more than one word
@@ -290,7 +290,7 @@ EXAMPLES = r'''
     password: 12345
     priv: "*.*:USAGE"
     state: present
-    sql_log_bin: no
+    sql_log_bin: false
 
 - name: Create user 'bob' authenticated with plugin 'AWSAuthenticationPlugin'
   community.mysql.mysql_user:

plugins/modules/mysql_variables.py

@@ -22,7 +22,7 @@ options:
     description:
     - Variable name to operate.
     type: str
-    required: yes
+    required: true
   value:
     description:
     - If set, then sets variable value to this.