Skip to content

Added missing docstrings to helper functions in sorts/tim_sort.py#14786

Open
DPug888 wants to merge 2 commits into
TheAlgorithms:masterfrom
DPug888:master
Open

Added missing docstrings to helper functions in sorts/tim_sort.py#14786
DPug888 wants to merge 2 commits into
TheAlgorithms:masterfrom
DPug888:master

Conversation

@DPug888

@DPug888 DPug888 commented Jun 9, 2026

Copy link
Copy Markdown

Describe your change:

Changes made:

  • Added detailed docstrings for binary_search()
  • Added detailed docstrings for insertion_sort()
  • Added detailed docstrings for merge()
  • Added parameter and return value documentation
  • Added doctest examples for helper functions
  • Added type annotations to improve readability and maintainability

These changes make the implementation easier to understand and follow, especially for new contributors and learners.

Fixes #14773

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests?
  • 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.
  • [v] 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 Add missing docstrings to helper functions in sorts/tim_sort.py #14773 ".

@algorithms-keeper algorithms-keeper Bot added enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed tests are failing Do not merge until tests pass labels Jun 9, 2026
@algorithms-keeper algorithms-keeper Bot removed the tests are failing Do not merge until tests pass label Jun 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting reviews This PR is ready to be reviewed enhancement This PR modified some existing files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add missing docstrings to helper functions in sorts/tim_sort.py

1 participant