source/text/sbasic/shared/03/sf_intro.xhp | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
New commits:
commit 811ee5d92e702abd73cb555f979f1d54a19a2389
Author: Alain Romedenne <alain.romede...@libreoffice.org>
AuthorDate: Mon Dec 9 11:11:11 2024 +0100
Commit: Alain Romedenne <alain.romede...@libreoffice.org>
CommitDate: Tue Dec 10 16:31:28 2024 +0100
Python typing hints are available for Scriptforge services
Change-Id: I0e5bcd7f39d4de7913080648cb6770e83253207c
Reviewed-on: https://gerrit.libreoffice.org/c/help/+/178131
Tested-by: Jenkins
Reviewed-by: Alain Romedenne <alain.romede...@libreoffice.org>
diff --git a/source/text/sbasic/shared/03/sf_intro.xhp
b/source/text/sbasic/shared/03/sf_intro.xhp
index 02e8d5a864..fd7a0101b3 100644
--- a/source/text/sbasic/shared/03/sf_intro.xhp
+++ b/source/text/sbasic/shared/03/sf_intro.xhp
@@ -10,7 +10,7 @@
-->
<meta>
- <topic id="SF_FormControl" indexer="include" status="PUBLISH">
+ <topic id="SF_intro" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">Creating Python Scripts with
ScriptForge</title>
<filename>/text/sbasic/shared/03/sf_intro.xhp</filename>
</topic>
@@ -47,6 +47,20 @@
</listitem>
</list>
<tip id="par_id31623411828158">Visit <link
href="text/sbasic/python/main0000.xhp#">%PRODUCTNAME Python Scripts Help</link>
for more information on Python scripting using %PRODUCTNAME.</tip>
+ <h2 id="hd_id402623411150191">Editing Python scripts in IDEs</h2>
+ <paragraph role="paragraph" id="par_id111733745619796">Python typing hints -
relating to <literal>ScriptForge</literal> services public methods and
properties - can be obtained from IDEs that support such facility. Visually,
while editing a user script:</paragraph>
+ <list type="unordered">
+ <listitem>
+ <paragraph id="par_id471733745941570" role="listitem">hovering an
object instance, a method or a property displays its detailed
description.</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id631733745943026" role="listitem">a "." after an
object instance displays a drop-down box listing all available
interfaces.</paragraph>
+ </listitem>
+ <listitem>
+ <paragraph id="par_id471733745961810" role="listitem">brackets after a
method-name start code-completion by displaying its arguments.</paragraph>
+ </listitem>
+ </list>
+ <note id="par_id571733746663339">Typing hints are displayed when editing
methods and properties with propercase letters.</note>
<h2 id="hd_id391623411150080">Running Python scripts on %PRODUCTNAME</h2>
<paragraph role="paragraph" id="par_id411623364895100">Depending on what you
intend to achieve, you may choose one of the following approaches to running
Python scripts in %PRODUCTNAME:</paragraph>
<list type="unordered">
