bellingcat / telegram-phone-number-checker

Check if phone numbers are connected to Telegram accounts.
https://pypi.org/project/telegram-phone-number-checker/
MIT License
1.02k stars 172 forks source link

Confusing docstring for validate_users #18

Closed omstaendlig closed 4 months ago

omstaendlig commented 4 months ago

I find the docstring of the function validate_users() confusing. It mentions get_api_response(), but there is no such function. The description of the return value is confusing as well: "the first user name and the last user name". Should it be "the first name, last name and username"?

def validate_users(client, phone_numbers):
    '''
    The function uses the get_api_response function to first check if the user exists and if it does, then it returns the first user name and the last user name.
    '''