Skip to content

test: cover insertion sort stability with equal-priority items - #15480

Open
gcomneno wants to merge 1 commit into
TheAlgorithms:masterfrom
gcomneno:test/insertion-sort-stability-doctest
Open

gcomneno wants to merge 1 commit into
TheAlgorithms:masterfrom
gcomneno:test/insertion-sort-stability-doctest

Conversation

@gcomneno

@gcomneno gcomneno commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

Describe your change

  • 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?

Add a doctest demonstrating that insertion sort preserves the relative order
of equal-priority items. The example compares items by priority only, keeping
their labels distinguishable.

Only the docstring in sorts/insertion_sort.py changes.

Validation

  • All 18 module doctests passed on Python 3.15t.
  • Applicable repository pre-commit hooks and git diff --check passed.
  • An in-memory mutation from < to <= reversed equal-priority items,
    confirming that the example detects loss of stability.
  • The full repository test suite was not run.

AI assistance

ChatGPT helped explain stability and prepare the example.
I reviewed the diff and ran the reported checks locally.

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

Unchecked conditional items are not applicable: no new files or algorithms are added, and this PR does not resolve an existing issue.

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

This branch has not been deployed

No deployments
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.

1 participant