Multisite: Clarify documentation for WP_Network::get_by_path().

See #31985.


git-svn-id: https://develop.svn.wordpress.org/trunk@35573 602fd350-edb4-49c9-b593-d223f7449a82

src/wp-includes/class-wp-network.php

@@ -169,7 +169,14 @@ class WP_Network {
 	}
 
 	/**
-	 * Retrieve a network by its domain and path.
+	 * Retrieve the closest matching network for a domain and path.
+	 *
+	 * This will not necessarily return an exact match for a domain and path. Instead, it
+	 * breaks the domain and path into pieces that are then used to match the closest
+	 * possibility from a query.
+	 *
+	 * The intent of this method is to match a network during bootstrap for a
+	 * requested site address.
 	 *
 	 * @since 4.4.0
 	 * @access public

src/wp-includes/ms-load.php

@@ -117,7 +117,7 @@ function ms_site_check() {
 }
 
 /**
- * Retrieve a network object by its domain and path.
+ * Retrieve the closest matching network for a domain and path.
  *
  * @since 3.9.0
  * @since 4.4.0 Converted to a wrapper for WP_Network::get_by_path()