Update levenshtein_distance.py

[pedram-mohajer]

Describe your change:

• Add an algorithm?
• Fix a bug or typo in an existing algorithm?
• Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
• Documentation change?

Checklist:

• I have read CONTRIBUTING.md.
• This pull request is all my own work -- I have not plagiarized.
• I know that pull requests will not be merged if they fail the automated tests.
• This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
• All new Python files are placed inside an existing directory.
• All filenames are in all lowercase characters with no spaces or dashes.
• All functions and variable names follow Python naming conventions.
• All function parameters and return values are annotated with Python type hints.
• All functions have doctests that pass the automated testing.
• [] All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
• [] If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

[cclauss]

This is a standard way to document parameters and return values. Please do not repeat the datatypes that are in the function signature because mypy validates them and readers will be confused if one is change and the other is not.

Suggested change

	first_word (str): The first word to measure the difference.
	second_word (str): The second word to measure the difference.
	Returns:
	int: The Levenshtein distance between the two words.
	:param first_word: the first word to measure the difference.
	:param second_word: the second word to measure the difference.
	:return: the Levenshtein distance between the two words.

[cclauss]

Let's keep both levenshtein_distance() and levenshtein_distance_optimized() in this file and please add a timeit benchmark that proves the enhanced performance of the latter.

[pedram-mohajer]

Hi There, Could you please help me how I can do ? Thanks, Best regards, Pedram

________________________________ From: Christian Clauss ***@***.***> Sent: Saturday, November 25, 2023 2:52 PM To: TheAlgorithms/Python ***@***.***> Cc: Pedram_Mohajer ***@***.***>; Author ***@***.***> Subject: Re: [TheAlgorithms/Python] Update levenshtein_distance.py (PR #11171) @cclauss commented on this pull request.

________________________________ In strings/levenshtein_distance.py<#11171 (comment)>:

+ first_word (str): The first word to measure the difference.

+ second_word (str): The second word to measure the difference. + + Returns: + int: The Levenshtein distance between the two words. This is a standard way to document parameters and return values. Please do not repeat the datatypes that are in the function signature because mypy validates them and readers will be confused if one is change and the other is not. ⬇️ Suggested change - first_word (str): The first word to measure the difference. - second_word (str): The second word to measure the difference. - - Returns: - int: The Levenshtein distance between the two words. + :param first_word: the first word to measure the difference. + :param second_word: the second word to measure the difference. + :return: the Levenshtein distance between the two words. — Reply to this email directly, view it on GitHub<#11171 (review)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ALVSFOXVX3R4GNFPU3C7XTDYGHIHBAVCNFSM6AAAAAA7T5NZVWVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMYTONBYHAYTSMZVGQ>. You are receiving this because you authored the thread.Message ID: ***@***.***>