From dfd5f5fd57f5992a37b65737e85f9e1e4363938d Mon Sep 17 00:00:00 2001 From: Danyal-Faheem Date: Mon, 16 Sep 2024 13:40:46 +0500 Subject: [PATCH] docs: reduce second person pronoun usage --- docs/local.rst | 8 ++++---- tutor/commands/jobs_utils.py | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/local.rst b/docs/local.rst index 0064148e9c..997c61ffa2 100644 --- a/docs/local.rst +++ b/docs/local.rst @@ -146,7 +146,7 @@ Changing the mysql charset and collation .. note:: This command has been tested only for users upgrading from Quince. While it is expected to work for users on earlier releases, please use it with caution as it has not been tested with those versions. -Your database's charset and collation might not support specific characters or emojis. Tutor will run fine without this change unless you explicity use specific characters in your instance. +The database's charset and collation might not support specific characters or emojis. Tutor will function normally without this change unless specific characters are used in the instance. .. warning:: This change is potentially irreversible. It is recommended to make a backup of the MySQL database. See the :ref:`database dump instructions ` to create a DB dump. @@ -154,17 +154,17 @@ To change the charset and collation of all the tables in the openedx database, r tutor local do convert-mysql-utf8mb4-charset -Alternatively, if you only want to change the charset and collation of certain tables or exclude certain tables, you can use the ``--include`` or ``--exclude`` options. These options take comma separated names of tables/apps with no space in-between. To upgrade the ``courseware_studentmodule`` and ``courseware_studentmodulehistory`` tables, run:: +Alternatively, to change the charset and collation of certain tables or to exclude certain tables, the ``--include`` or ``--exclude`` options can be used. These options take comma separated names of tables/apps with no space in-between. To upgrade the ``courseware_studentmodule`` and ``courseware_studentmodulehistory`` tables, run:: tutor local do convert-mysql-utf8mb4-charset --include=courseware_studentmodule,courseware_studentmodulehistory -Tutor performs pattern matching from the start of the table name so you can just enter the name of the app to include/exclude all the tables under that app. To upgrade all the tables in the database except the ones under the student and wiki apps, run:: +Tutor performs pattern matching from the start of the table name so just the name of the app is enough to include/exclude all the tables under that app. To upgrade all the tables in the database except the ones under the student and wiki apps, run:: tutor local do convert-mysql-utf8mb4-charset --exclude=student,wiki In the above command, all the tables whose name starts with either student or wiki will be excluded from the upgrade process. -By default, only the tables in the openedx database are changed. If you are running any plugins with their own databases, you can upgrade them by utilizing the ``--database`` option. To upgrade all the tables in the discovery database, run:: +By default, only the tables in the openedx database are changed. For upgrading tables in any additional databases used by plugins, the ``--database`` option can be used to upgrade them. To upgrade all the tables in the discovery database, run:: tutor local do convert-mysql-utf8mb4-charset --database=discovery diff --git a/tutor/commands/jobs_utils.py b/tutor/commands/jobs_utils.py index b4e88134c3..e0d7dbbb0d 100644 --- a/tutor/commands/jobs_utils.py +++ b/tutor/commands/jobs_utils.py @@ -2,7 +2,7 @@ This module provides utility methods for tutor `do` commands Methods: -- `get_mysql_change_charset_query`: Generates MySQL queries to upgrade the charset and collation of tables +- `get_mysql_change_charset_query`: Generates MySQL queries to upgrade the charset and collation of columns, tables, and databases. """ @@ -14,7 +14,7 @@ def get_mysql_change_charset_query( charset_to_upgrade_from: str, ) -> str: """ - Helper function to generate the mysql query to upgrade the charset and collation of tables + Helper function to generate the mysql query to upgrade the charset and collation of columns, tables, and databases Utilized in the `tutor local do convert-mysql-utf8mb4-charset` command """