Updating docs for getNumberType (#1863)

cpp/src/phonenumbers/phonenumberutil.h

@@ -422,7 +422,7 @@ class PhoneNumberUtil : public Singleton<PhoneNumberUtil> {
   // be successfully extracted.
   bool TruncateTooLongNumber(PhoneNumber* number) const;
 
-  // Gets the type of a phone number.
+  // Gets the type of a valid phone number, or UNKNOWN if it is invalid.
   PhoneNumberType GetNumberType(const PhoneNumber& number) const;
 
   // Tests whether a phone number matches a valid pattern. Note this doesn't

java/libphonenumber/src/com/google/i18n/phonenumbers/PhoneNumberUtil.java

@@ -2138,10 +2138,10 @@ public class PhoneNumberUtil {
   }
 
   /**
-   * Gets the type of a phone number.
+   * Gets the type of a valid phone number.
    *
    * @param number  the phone number that we want to know the type
-   * @return  the type of the phone number
+   * @return  the type of the phone number, or UNKNOWN if it is invalid
    */
   public PhoneNumberType getNumberType(PhoneNumber number) {
     String regionCode = getRegionCodeForNumber(number);

javascript/i18n/phonenumbers/phonenumberutil.js

@@ -2807,11 +2807,12 @@ i18n.phonenumbers.PhoneNumberUtil.getNumberDescByType_ =
 
 
 /**
- * Gets the type of a phone number.
+ * Gets the type of a valid phone number.
  *
  * @param {i18n.phonenumbers.PhoneNumber} number the phone number that we want
  *     to know the type.
- * @return {i18n.phonenumbers.PhoneNumberType} the type of the phone number.
+ * @return {i18n.phonenumbers.PhoneNumberType} the type of the phone number, or
+ *     UNKNOWN if it is invalid.
  */
 i18n.phonenumbers.PhoneNumberUtil.prototype.getNumberType =
     function(number) {

pending_code_changes.txt

@@ -1 +1,2 @@
-
+Code changes:
+ - Documentation fix for getNumberType