Skip to content

Conversation

@Tithi234
Copy link

What does this PR do?

  • Updates the docstring to follow the repository’s preferred style
  • Replaces ValueError with TypeError for invalid input types

Why is this useful?

This improves documentation consistency and aligns error handling
with standard Python practices, without changing behavior.

Updated docstring format and fixed exception type.
@Tithi234
Copy link
Author

Thanks for taking a look!

This PR keeps all existing logic and doctests unchanged and only
improves docstring consistency and Pythonic error handling.
Happy to adjust if needed.

@algorithms-keeper
Copy link

Closing this pull request as invalid

@Tithi234, this pull request is being closed as none of the checkboxes have been marked. It is important that you go through the checklist and mark the ones relevant to this pull request. Please read the Contributing guidelines.

If you're facing any problem on how to mark a checkbox, please read the following instructions:

  • Read a point one at a time and think if it is relevant to the pull request or not.
  • If it is, then mark it by putting a x between the square bracket like so: [x]

NOTE: Only [x] is supported so if you have put any other letter or symbol between the brackets, that will be marked as invalid. If that is the case then please open a new pull request with the appropriate changes.

@algorithms-keeper algorithms-keeper bot added invalid awaiting reviews This PR is ready to be reviewed labels Jan 23, 2026
@algorithms-keeper algorithms-keeper bot removed the awaiting reviews This PR is ready to be reviewed label Jan 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant