DSA icon indicating copy to clipboard operation
DSA copied to clipboard

Enhance twoSum function for readability and documentation

Open Vignesh-Jothi opened this issue 1 year ago • 1 comments

  • Renamed the function to two_sum_indices for better readability and adherence to Python naming conventions.
  • Added a detailed docstring to the function, explaining its purpose, parameters, and return value.
  • Improved variable names to enhance code comprehension.
  • Included comments for better explanation of each step in the solution.
  • Utilized more user-friendly messages for input and output in the main function.
  • Encapsulated the code in a try block to gracefully handle potential input errors.
  • Added a default input in case of a ValueError during user input.

PR Checklist:

  • [x] My submission is formatted according to the guidelines in the contributing guide
  • [x] My addition is on refer on the language README.md file
  • [x] My addition does not have a spelling problem
  • [x] My submission has a proper and user-friendly description of the algorithm

What kind of change does this PR introduce? (check at least one)

  • [x] Code style update
  • [x] Refactor
  • [x] Documentation

Vignesh-Jothi avatar Dec 02 '23 13:12 Vignesh-Jothi

Thanks for opening this pull request! Please check out our contributing guidelines.

welcome[bot] avatar Dec 02 '23 13:12 welcome[bot]