From: Jean-Marc Lasgouttes <lasgouttes@lyx.org>
Date: Tue, 10 Jan 2023 15:25:48 +0000 (+0100)
Subject: Correct the description of Lexer::getLongString
X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=8ec3397da32ff9af970b98d4de2440a86d846bd3;p=features.git

Correct the description of Lexer::getLongString

The fact that it does not work with tabs has been fixed long ago.
---

diff --git a/src/Lexer.h b/src/Lexer.h
index 6ecdd90989..02ec7470e1 100644
--- a/src/Lexer.h
+++ b/src/Lexer.h
@@ -138,12 +138,10 @@ public:
 	std::string const getString(bool trim = false) const;
 	///
 	docstring const getDocString(bool trim = false) const;
-	/** Get a long string, ended by the tag `endtoken'.
-	    This string can span several lines. The first line
-	    serves as a template for how many spaces the lines
-	    are indented. This much white space is skipped from
-	    each following line. This mechanism does not work
-	    perfectly if you use tabs.
+	/** Get a long string, ended by the tag `endtoken'. This string
+	    can span several lines. The first line serves as a template
+	    for what sequence of tabs and spaces make up the indentation.
+	    This prefix is skipped from each following line.
 	*/
 	docstring getLongString(docstring const & endtoken);