Skip to content

Improve docstrings in sorts/bubble_sort.py#14924

Open
alisatwat3 wants to merge 1 commit into
TheAlgorithms:masterfrom
alisatwat3:docs/bubble-sort-docstrings
Open

Improve docstrings in sorts/bubble_sort.py#14924
alisatwat3 wants to merge 1 commit into
TheAlgorithms:masterfrom
alisatwat3:docs/bubble-sort-docstrings

Conversation

@alisatwat3

@alisatwat3 alisatwat3 commented Jul 12, 2026

Copy link
Copy Markdown

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?

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 #14911

@alisatwat3
docs: expand bubble sort docstrings with algorithm explanation
5377d01 
Add a concise description of how bubble sort works (repeated
adjacent comparisons/swaps until a pass makes no swaps) and note
time/space complexity for both the iterative and recursive
implementations. No behavior changes; all existing doctests pass.
@algorithms-keeper algorithms-keeper Bot added enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed labels Jul 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

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

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve Bubble Sort docstrings with a more descriptive algorithm summary

1 participant

@alisatwat3