Skip to content

Add missing docstrings to tim_sort helper functions#14785

Open
varun-katara wants to merge 2 commits into
TheAlgorithms:masterfrom
varun-katara:add-tim-sort-docstrings
Open

Add missing docstrings to tim_sort helper functions#14785
varun-katara wants to merge 2 commits into
TheAlgorithms:masterfrom
varun-katara:add-tim-sort-docstrings

Conversation

@varun-katara

Copy link
Copy Markdown

Describe your change:

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

  • binary_search()
  • insertion_sort()
  • merge()
  • main()

These docstrings improve readability and make the file consistent with existing documentation.

Fixes #14773

  • 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".

@algorithms-keeper algorithms-keeper Bot added enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed labels Jun 9, 2026
@DPug888

DPug888 commented Jun 9, 2026

Copy link
Copy Markdown

Nice work @varun-katara! But I really think it would be great if we can do a line for param and args, explaining them, so that it would be great for total beginners! So even if they get a little confused, they can look into the docstrings properly. I believe it will also encourage beginners to practice looking for docstrings within the file for their doubts, rather than relying on other sources.
I've made some changes regarding this in #14786 . What do you think about those?

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