[Bf-docboard-svn] bf-manual: [7373] trunk/blender_docs/tools_maintenance/change_shortcuts/readme.txt: change_shortcuts scripts minor doc fix

[Pep]

Revision: 7373
          https://developer.blender.org/rBM7373
Author:   pepribal
Date:     2020-11-14 12:26:06 +0100 (Sat, 14 Nov 2020)
Log Message:
-----------
change_shortcuts scripts minor doc fix

Modified Paths:
--------------
    trunk/blender_docs/tools_maintenance/change_shortcuts/readme.txt

Modified: trunk/blender_docs/tools_maintenance/change_shortcuts/readme.txt
===================================================================
--- trunk/blender_docs/tools_maintenance/change_shortcuts/readme.txt	2020-11-14 11:10:39 UTC (rev 7372)
+++ trunk/blender_docs/tools_maintenance/change_shortcuts/readme.txt	2020-11-14 11:26:06 UTC (rev 7373)
@@ -2,13 +2,14 @@
 ================
 
 Scripts to bulk change shortcut (:kbd:`...`) and menu item (:menuselection:`...`) names.
+Use with care!!
 
 
 
 change_man_shortcuts.py
 -----------------------
-It changes all the shortcuts in the manual according to a CSV substitution table.
-If one of the entries is, for instance:
+It changes all the shortcuts and menu items in RST files of the the manual according
+to a CSV substitution table. If one of the entries in the table is, for instance:
 
 LMB;LeftMouse
 
@@ -21,7 +22,7 @@
 The file 'table.csv' must be in the same folder as the script.
 
 On completion, a 'new_manual' subfolder will be created in the script folder.
-In it, you will find all the RST files that had replacements. You can check them
+In it, you will find all the RST files that were changed. You can check them
 before dumping and replacing the desired files onto the repository.
 
 
@@ -28,7 +29,7 @@
 
 change_tr_shortcuts.py
 ----------------------
-It does the same thing as 'change_man_shortcuts.py', but for translations.
+Same thing as 'change_man_shortcuts.py', but for translations.
 You must specify a language (e.g. 'es'), and provide a substitution table
 (e.g. 'table_es.csv') in the same folder as the script.
 
@@ -42,7 +43,7 @@
 diff_man_shortcuts.py
 ---------------------
 Useful for checking all the differences between the newly generated RST files
-and the current files in the repository. a file 'diff_man.txt' will be generated
+and the current files in the repository. A file 'diff_man.txt' will be generated
 in the script folder, with all the differences.
 
 
@@ -64,9 +65,10 @@
 
 list_man_shortcuts.py
 --------------------
-Shows the list of :kbd: items, and the list of :menuselection: items present in the RST files
-of the manual. Lists are alphabetically sorted. This is useful to check that all the items have
-a right format.
+Shows two lists: one for all the :kbd: items, and one for all the :menuselection: items
+present in the RST files of the manual. Lists are alphabetically sorted.
+This is useful to check that all the items have a right format. To locate which files
+contain a specific name, use 'find_man_shortcuts.py'.
 
 
 
@@ -73,17 +75,18 @@
 list_tr_shortcuts.py
 --------------------
 Same as 'list_man_shortcuts.py', but for a specific language translation (items in 'msgstr' strings
-in PO files).
+in PO files). To locate which files contain a specific name, use 'find_tr_shortcuts.py'.
 
 
 
 find_man_shortcuts.py
 ---------------------
-Used to find which RST in the repository files contain the exact name in a :kbd: or :menuselection: item.
+Used to find which RST files in the repository contain a specific exact name in a :kbd: or :menuselection: item.
 
 
 
 find_tr_shortcuts.py
 --------------------
-The same as 'find_man_shortcuts.py' but searching only in 'msgstr' in the PO files of the specified translation.
+The same as 'find_man_shortcuts.py' but searching only in 'msgstr' strings in the PO files of
+the specified translation.