Skip to content

Add missing docstrings to helper functions in tim_sort#14883

Open
shreya-learn-explores wants to merge 1 commit into
TheAlgorithms:masterfrom
shreya-learn-explores:add-docstrings-tim-sort-helpers
Open

Add missing docstrings to helper functions in tim_sort#14883
shreya-learn-explores wants to merge 1 commit into
TheAlgorithms:masterfrom
shreya-learn-explores:add-docstrings-tim-sort-helpers

Conversation

@shreya-learn-explores

Copy link
Copy Markdown

Describe your change:

This pull request adds missing docstrings to the helper functions in sorts/tim_sort.py.

Changes made:
* Added a docstring to binary_search()
* Added a docstring to insertion_sort()
* Added a docstring to merge()
* Added a docstring to main()

These changes improve code readability and make the file more consistent with the rest of the repository.

  • 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 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 labels Jul 1, 2026

@zain-cs zain-cs left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work adding docstrings to the helper functions! A couple of suggestions to align with TheAlgorithms repo standards:

  1. Missing doctests — TheAlgorithms requires doctests in all functions. Please add >>> examples to binary_search(), insertion_sort(), and merge(). For example:

python

def insertion_sort(lst):
"""
Sort a list using the insertion sort algorithm.
>>> insertion_sort([3, 2, 1])
[1, 2, 3]
>>> insertion_sort([1])
[1]
"""

  1. Docstring style — The repo generally uses plain docstrings with >>> examples rather than Sphinx :param: style. Consider simplifying to match the existing style in the repo.

Otherwise the changes are clean and improve the file's readability! 👍

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

2 participants