Skip to content

docs: Improve bubble sort documentation with beginner-friendly explan…#14488

Closed
nareshkoundel wants to merge 1 commit intoTheAlgorithms:masterfrom
nareshkoundel:improve-bubble-sort-documentation
Closed

docs: Improve bubble sort documentation with beginner-friendly explan…#14488
nareshkoundel wants to merge 1 commit intoTheAlgorithms:masterfrom
nareshkoundel:improve-bubble-sort-documentation

Conversation

@nareshkoundel
Copy link
Copy Markdown

@nareshkoundel nareshkoundel commented Mar 31, 2026

Improved documentation for the bubble sort algorithm with beginner-friendly explanations and inline comments to help learners understand the algorithm step-by-step.

Changes made:

  • Add comprehensive algorithm explanation and complexity analysis

  • Include step-by-step inline comments for iterative implementation

  • Add detailed comments for recursive implementation

  • Explain the algorithm flow, comparison logic, and optimization techniques

  • Include complexity information (Time: O(n²), Space: O(1) for iterative)

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

…ations

- Add comprehensive algorithm explanation and complexity analysis
- Include step-by-step inline comments for iterative implementation
- Add detailed comments for recursive implementation
- Explain the algorithm flow, comparison logic, and optimization techniques
- Include complexity information (Time: O(n²), Space: O(1) for iterative)
@algorithms-keeper
Copy link
Copy Markdown

Closing this pull request as invalid

@nareshkoundel, this pull request is being closed as none of the checkboxes have been marked. It is important that you go through the checklist and mark the ones relevant to this pull request. Please read the Contributing guidelines.

If you're facing any problem on how to mark a checkbox, please read the following instructions:

  • Read a point one at a time and think if it is relevant to the pull request or not.
  • If it is, then mark it by putting a x between the square bracket like so: [x]

NOTE: Only [x] is supported so if you have put any other letter or symbol between the brackets, that will be marked as invalid. If that is the case then please open a new pull request with the appropriate changes.

@algorithms-keeper algorithms-keeper bot added awaiting reviews This PR is ready to be reviewed and removed awaiting reviews This PR is ready to be reviewed labels Mar 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant