Documentation inconsistencies making it harder for beginners to learn from the code

[saikirankanakala]

Feature description

Hey maintainers,
I've been going through the repository over the past few weeks to learn algorithms, and I have to say this project is incredible. However, I've noticed something that's been making my learning experience a bit bumpy.
The Problem I'm Running Into:
The documentation style varies wildly between different files. Sometimes I'll find really well-explained functions with clear examples, and other times I'm left guessing what parameters do or what the function returns. For someone trying to learn, this inconsistency makes it tough to know if I'm understanding things correctly.
Here are some specific things I've noticed:

Some algorithms have detailed docstrings explaining every parameter, while others just have a one-liner
Type hints are present in some files but missing in others
Time/space complexity is documented sometimes, but not consistently
Example usage with doctests exists for some functions but not all

What I Think Would Help:
It would be really helpful to have a consistent documentation standard across the repo. Something like:
pythondef binary_search(arr: list[int], target: int) -> int:
"""
Search for a target value in a sorted array using binary search.

This algorithm repeatedly divides the search interval in half. If the target
value is less than the middle element, search the left half, otherwise search
the right half.

Args:
    arr: Sorted list of integers to search through
    target: Integer value we're looking for

Returns:
    Index position of target in arr, returns -1 if target isn't found

Time Complexity: O(log n) - halves the search space each iteration
Space Complexity: O(1) - only uses a constant amount of extra space

Examples:
    >>> binary_search([1, 3, 5, 7, 9], 5)
    2
    >>> binary_search([1, 3, 5, 7, 9], 6)
    -1
"""
# implementation

Why This Matters:
This repository is often recommended to beginners (including me!), and having consistent, clear documentation would make it so much more valuable as a learning resource. Right now, I sometimes have to jump to Wikipedia or other sources to understand what's happening, when ideally the code itself should be self-explanatory.
How I Can Help:
If the maintainers are open to this, I'd be happy to start contributing documentation improvements. I could:

Work on standardizing docs for the sorting and searching algorithms first
Create a simple style guide that contributors can follow
Submit PRs gradually so it's not overwhelming

I know this is a big task, but I think it would significantly improve the educational value of what's already an amazing resource. What do you all think?
Thanks for maintaining this project!

[sharvandeep]

Hi — I'd like to work on this issue. I will clean up and standardize the docstrings across a few algorithms according to the project's guidelines.