* layouttranslations.review - sk reviewed by Kornel

[lyx.git] / lib / lyx2lyx / parser_tools.py

diff --git a/lib/lyx2lyx/parser_tools.py b/lib/lyx2lyx/parser_tools.py
index 9af9b60a7e5397cfb6258bae118169336b3f939f..c989515e4120156e7f8068e7866f3dd2845a20d8 100644 (file)
--- a/lib/lyx2lyx/parser_tools.py
+++ b/lib/lyx2lyx/parser_tools.py
@@ -19,7 +19,7 @@
 
 
 ''' 
-This modules offer several free functions to help parse lines.
+This module offers several free functions to help parse lines.
 More documentaton is below, but here is a quick guide to what 
 they do. Optional arguments are marked by brackets.
 
@@ -32,11 +32,11 @@ find_token(lines, token, start[, end[, ignorews]]):
   extra whitespace following token itself.
 
 find_token_exact(lines, token, start[, end]):
-  As find_token, but with ignorews True.
+  As find_token, but with ignorews set to True.
 
 find_tokens(lines, tokens, start[, end[, ignorews]]):
   Returns the first line i, start <= i < end, on which
-  oen of the tokens in tokens is found at the beginning. 
+  one of the tokens in tokens is found at the beginning. 
   Returns -1 if not found. 
   If ignorews is (given and) True, then differences
   in whitespace do not count, except that there must be no 
@@ -106,7 +106,9 @@ find_end_of_layout(lines, i):
 
 find_end_of_sequence(lines, i):
   Find the end of the sequence of layouts of the same kind.
-  Considers nesting.
+  Considers nesting. If the last paragraph in sequence is nested,
+  the position of the last \end_deeper is returned, else
+  the position of the last \end_layout.
 
 is_in_inset(lines, i, inset):
   Checks if line i is in an inset of the given type.
@@ -123,7 +125,7 @@ is_in_inset(lines, i, inset):
 
 get_containing_inset(lines, i):
   Finds out what kind of inset line i is within. Returns a 
-  list containing what follows \begin_inset on the the line 
+  list containing what follows \begin_inset on the line 
   on which the inset begins, plus the starting and ending line.
   Returns False on any kind of error or if it isn't in an inset.
   So get_containing_inset(document.body, i) might return:
@@ -135,7 +137,6 @@ get_containing_layout(lines, i):
   As get_containing_inset, but for layout. Additionally returns the
   position of real paragraph start (after par params) as 4th value.
 
-
 find_nonempty_line(lines, start[, end):
   Finds the next non-empty line.
 
@@ -424,7 +425,7 @@ def is_in_inset(lines, i, inset):
 def get_containing_inset(lines, i):
   ''' 
   Finds out what kind of inset line i is within. Returns a 
-  list containing (i) what follows \begin_inset on the the line 
+  list containing (i) what follows \begin_inset on the line 
   on which the inset begins, plus the starting and ending line.
   Returns False on any kind of error or if it isn't in an inset.
   '''
@@ -448,9 +449,10 @@ def get_containing_inset(lines, i):
 def get_containing_layout(lines, i):
   ''' 
   Finds out what kind of layout line i is within. Returns a 
-  list containing (i) what follows \begin_layout on the the line 
+  list containing what follows \begin_layout on the line 
   on which the layout begins, plus the starting and ending line
-  and the start of the apargraph (after all params).
+  and the start of the paragraph (after all params). I.e, returns:
+    (layoutname, layoutstart, layoutend, startofcontent)
   Returns False on any kind of error.
   '''
   j = i
@@ -513,6 +515,7 @@ def find_end_of_sequence(lines, i):
           j = find_end_of(lines, i, "\\begin_deeper", "\\end_deeper")
           if j != -1:
               i = j
+              endlay = j
               continue
       if m and m.group(1) == layout:
           endlay = find_end_of_layout(lines, i)