[utilities/kate] doc/kate: Add a bit on non-obvious internals of snippet-scripts.

[Christoph Cullmann]

Git commit bbdb00c136290021d642b6d9b20c0e04a8ecc9bf by Christoph Cullmann, on behalf of Thomas Friedrichsmeier.
Committed on 26/06/2022 at 20:50.
Pushed by cullmann into branch 'master'.

Add a bit on non-obvious internals of snippet-scripts.

M  +6    -1    doc/kate/plugins.docbook

https://invent.kde.org/utilities/kate/commit/bbdb00c136290021d642b6d9b20c0e04a8ecc9bf

diff --git a/doc/kate/plugins.docbook b/doc/kate/plugins.docbook
index c03c8161e..c9b4e3a76 100644
--- a/doc/kate/plugins.docbook
+++ b/doc/kate/plugins.docbook
@@ -3434,7 +3434,12 @@ the <ulink url="help:/katepart/dev-scripting.html#dev-scripting-api">&kate; scri
 to get the selected text, full text, file name and
 more by using the appropriate methods of the <userinput>document</userinput>
 and <userinput>view</userinput> objects. Refer to the scripting API
-documentation for more information</para>
+documentation for more information.</para>
+<para>For more complex scripts it may be important to understand that
+<emphasis>first</emphasis>, the raw snippet is inserted into the document, and <emphasis>then</emphasis>
+functions are being evaluated. E.g., if a function retrieves the text on the
+line where the snippet is being inserted, that text will also contain
+<userinput>${functionCall()}</userinput>.</para>
 </listitem>
 </varlistentry>