From fe38b648b0a5b2d9e9ad2b1faf857f97ac9bbba6 Mon Sep 17 00:00:00 2001
From: Poommetee Ketson
Date: Fri, 23 Feb 2018 21:58:14 +0700
Subject: [DOCS] clarify that OS.get_user_data_dir needs project name

[ci skip]

(cherry picked from commit 2c22c9dcfbad9639fb9254eb822f9f930cf852db)
---
 doc/classes/OS.xml | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'doc/classes')

diff --git a/doc/classes/OS.xml b/doc/classes/OS.xml
index e6cc69061..00903608e 100644
--- a/doc/classes/OS.xml
+++ b/doc/classes/OS.xml
@@ -384,6 +384,10 @@
 			</return>
 			<description>
 				Returns the absolute directory path where user data is written ([code]user://[/code]).
+				On Linux, this is [code]~/.local/share/godot/app_userdata/[project_name][/code], or [code]~/.local/share/[custom_name][/code] if [code]use_custom_user_dir[/code] is set.
+				On macOS, this is [code]~/Library/Application Support/Godot/app_userdata/[project_name][/code], or [code]~/Library/Application Support/[custom_name][/code] if [code]use_custom_user_dir[/code] is set.
+				On Windows, this is [code]%APPDATA%/Godot/app_userdata/[project_name][/code], or [code]%APPDATA%/[custom_name][/code] if [code]use_custom_user_dir[/code] is set.
+				If the project name is empty, [code]user://[/code] falls back to [code]res://[/code].
 			</description>
 		</method>
 		<method name="get_virtual_keyboard_height">
-- 
cgit v1.2.3-70-g09d2