Upgrade comments of all functions to write params, returns properly

[krishnaglodha]

We should move to more standard format like

def format_greeting(name, greeting="Hello"):
    """
    Format a personalized greeting.

    Parameters:
    - name (str): The name of the person to greet.
    - greeting (str, optional): The greeting to use (default is "Hello").

    Returns:
    str: A formatted greeting string.
    """
    return f"{greeting}, {name}!"

as opposed to current

def _doc_location(rst_path: str, doc_link: str) ->  str:
    """
    Determines absolute path location for link, relative to provided path.

    Do not use as is, mkdocs only works with relative links

    :param rst_path: path of rst file providing the documentation link
    :param doc_link: documentation link (may be absolute or relative)
    :return: absolute path, indicating location relative to docs folder. Used for looking up title.
    """