Improve the String.is_valid_ip_address() documentation

This closes godotengine/godot-docs#4097.
schme · Sep 30, 2020 · 00ade39 · 00ade39
1 parent cc62eaf
commit 00ade39
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/doc/classes/String.xml b/doc/classes/String.xml
@@ -615,7 +615,7 @@
 			<return type="bool">
 			</return>
 			<description>
-				Returns [code]true[/code] if this string contains a valid IP address.
+				Returns [code]true[/code] if this string contains only a well-formatted IPv4 or IPv6 address. This method considers [url=https://en.wikipedia.org/wiki/Reserved_IP_addresses]reserved IP addresses[/url] such as [code]0.0.0.0[/code] as valid.
 			</description>
 		</method>
 		<method name="join">