Browse Source

Merge pull request #42435 from Calinou/doc-string-is-valid-ip-address

Improve the `String.is_valid_ip_address()` documentation
Rémi Verschelde 4 years ago
parent
commit
42f2098509
1 changed files with 1 additions and 1 deletions
  1. 1 1
      doc/classes/String.xml

+ 1 - 1
doc/classes/String.xml

@@ -618,7 +618,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">