Add docstring

geotribu · Apr 13, 2024 · 5e5dd90 · 5e5dd90
1 parent 78e6771
commit 5e5dd90
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/qtribu/toolbelt/commons.py b/qtribu/toolbelt/commons.py
@@ -3,4 +3,12 @@
 
 
 def open_url_in_browser(url: str) -> bool:
+    """Opens an url in a browser using user's desktop environment
+
+    :param url: url to open
+    :type url: str
+
+    :return: true if successful otherwise false
+    :rtype: bool
+    """
     return QDesktopServices.openUrl(QUrl(url))