summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRĂ©mi Verschelde <rverschelde@gmail.com>2019-09-24 10:29:04 +0200
committerGitHub <noreply@github.com>2019-09-24 10:29:04 +0200
commit5c0de2c2498e17adde58e87ba46827ad1a73f698 (patch)
tree16a70a51266753a2316b3c67565172f9de9b2c77 /doc
parent5d4e9bdd9e0d77cfeaa6994c391a107d2a17706a (diff)
parent5d676682b405e9259b13ebba008978bbd383d206 (diff)
Merge pull request #32286 from Calinou/doc-improve-os-shell-open
Improve the `OS.shell_open()` documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/classes/OS.xml7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index afa0222c6e..9f61245819 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -829,9 +829,10 @@
<argument index="0" name="uri" type="String">
</argument>
<description>
- Requests the OS to open a resource with the most appropriate program. For example.
- [code]OS.shell_open("C:\\Users\name\Downloads")[/code] on Windows opens the file explorer at the downloads folders of the user.
- [code]OS.shell_open("https://godotengine.org")[/code] opens the default web browser on the official Godot website.
+ Requests the OS to open a resource with the most appropriate program. For example:
+ - [code]OS.shell_open("C:\\Users\name\Downloads")[/code] on Windows opens the file explorer at the user's Downloads folder.
+ - [code]OS.shell_open("https://godotengine.org")[/code] opens the default web browser on the official Godot website.
+ - [code]OS.shell_open("mailto:example@example.com")[/code] opens the default email client with the "To" field set to [code]example@example.com[/code]. See [url=https://blog.escapecreative.com/customizing-mailto-links/]Customizing [code]mailto:[/code] Links[/url] for a list of fields that can be added.
</description>
</method>
<method name="show_virtual_keyboard">