# HG changeset patch
# User Bram Moolenaar <Bram@vim.org>
# Date 1639666805 -3600
# Node ID 9f445e07f766a2daa1cb202f42033f1502b4cbdf
# Parent  3a63b1e4a6f4f95a1ce3ba3e7b7dd04f18b75643
patch 8.2.3825: various comments could be improved

Commit: https://github.com/vim/vim/commit/52797bae1710621926c03a2611c40a692c96fb44
Author: Bram Moolenaar <Bram@vim.org>
Date:   Thu Dec 16 14:45:13 2021 +0000

    patch 8.2.3825: various comments could be improved

    Problem:    Various comments could be improved.
    Solution:   Improve the comments.

diff --git a/src/getchar.c b/src/getchar.c
--- a/src/getchar.c
+++ b/src/getchar.c
@@ -2677,7 +2677,7 @@ handle_mapping(
 		if (mp == NULL)
 		{
 		    *keylenp = keylen;
-		    return map_result_get;    // got character, break for loop
+		    return map_result_get;    // get character from typeahead
 		}
 	}
 
@@ -3060,7 +3060,7 @@ vgetorpeek(int advance)
 						      typebuf.tb_off];
 			    del_typebuf(1, 0);
 			}
-			break;
+			break;  // got character, break the for loop
 		    }
 
 		    // not enough characters, get more
diff --git a/src/gui_motif.c b/src/gui_motif.c
--- a/src/gui_motif.c
+++ b/src/gui_motif.c
@@ -3995,7 +3995,7 @@ gui_mch_replace_dialog(exarg_T *eap)
 }
 
 /*
- * Synchronize all gui elements, which are dependant upon the
+ * Synchronize all gui elements, which are dependent upon the
  * main text font used. Those are in esp. the find/replace dialogs.
  * If you don't understand why this should be needed, please try to
  * search for "pi\xea\xb6\xe6" in iso8859-2.
diff --git a/src/mbyte.c b/src/mbyte.c
--- a/src/mbyte.c
+++ b/src/mbyte.c
@@ -3847,6 +3847,11 @@ dbcs_screen_head_off(char_u *base, char_
     return (q == p) ? 0 : 1;
 }
 
+/*
+ * Return offset from "p" to the start of a character, including composing
+ * characters.  "base" must be the start of the string, which must be NUL
+ * terminated.
+ */
     int
 utf_head_off(char_u *base, char_u *p)
 {
@@ -4107,6 +4112,7 @@ mb_off_next(char_u *base, char_u *p)
 /*
  * Return the offset from "p" to the last byte of the character it points
  * into.  Can start anywhere in a stream of bytes.
+ * Composing characters are not included.
  */
     int
 mb_tail_off(char_u *base, char_u *p)
diff --git a/src/regexp_nfa.c b/src/regexp_nfa.c
--- a/src/regexp_nfa.c
+++ b/src/regexp_nfa.c
@@ -18,7 +18,7 @@
  * The last three are enabled when compiled as debug mode and individually
  * disabled by commenting them out.
  * The log files can get quite big!
- * Do disable all of this when compiling Vim for debugging, undefine DEBUG in
+ * To disable all of this when compiling Vim for debugging, undefine DEBUG in
  * regexp.c
  */
 #ifdef DEBUG
diff --git a/src/testdir/test_edit.vim b/src/testdir/test_edit.vim
--- a/src/testdir/test_edit.vim
+++ b/src/testdir/test_edit.vim
@@ -1326,6 +1326,7 @@ func Test_edit_forbidden()
   call assert_fails(':Sandbox', 'E48:')
   delcom Sandbox
   call assert_equal(['a'], getline(1,'$'))
+
   " 2) edit with textlock set
   fu! DoIt()
     call feedkeys("i\<del>\<esc>", 'tnix')
@@ -1345,6 +1346,7 @@ func Test_edit_forbidden()
   catch /^Vim\%((\a\+)\)\=:E117/ " catch E117: unknown function
   endtry
   au! InsertCharPre
+
   " 3) edit when completion is shown
   fun! Complete(findstart, base)
     if a:findstart
@@ -1362,6 +1364,7 @@ func Test_edit_forbidden()
   endtry
   delfu Complete
   set completefunc=
+
   if has("rightleft") && exists("+fkmap")
     " 4) 'R' when 'fkmap' and 'revins' is set.
     set revins fkmap
diff --git a/src/version.c b/src/version.c
--- a/src/version.c
+++ b/src/version.c
@@ -750,6 +750,8 @@ static char *(features[]) =
 static int included_patches[] =
 {   /* Add new patch number below this line */
 /**/
+    3825,
+/**/
     3824,
 /**/
     3823,