Skip to content

docs: add docstring and doctests to generate_all_permutations) - #15055

Open
dwaddle wants to merge 1 commit into
TheAlgorithms:masterfrom
dwaddle:add-docstring-all-permutations
Open

docs: add docstring and doctests to generate_all_permutations)#15055
dwaddle wants to merge 1 commit into
TheAlgorithms:masterfrom
dwaddle:add-docstring-all-permutations

Conversation

@dwaddle

@dwaddle dwaddle commented Aug 20, 2026

Copy link
Copy Markdown

This pull request adds a missing docstring to the generate_all_permutations
function in backtracking/all_permutations.py to improve code readability and
maintainability. It also includes two simple doctests to verify the correct
behavior of the function.

- [x] Added a docstring explaining the function's purpose
- [x] Added `doctests` for basic list and string inputs
- [x] Ran `pytest` locally and all tests passed successfully

This is my first contribution to this repository. Let me know if any changes are

required!

@algorithms-keeper algorithms-keeper Bot added enhancement This PR modified some existing files awaiting reviews This PR is ready to be reviewed labels Aug 20, 2026
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