flow-forecast Update all docstrings to be ReadTheDocs compatible and fill in missing docstrings

ReadTheDocs requires docstrings to have an additional newline between the header and the parameters if strings are not in this format it will not render properly. Therefore we want to put all docstrings into the following format

def some_function(a_number: int, a_string: str) -> str:
    """
    A function that concatenates a string to 

    :param a_number:  A number that ....
     :type a_number: int
     :param a_string: Some string that does something
     :type  a_string: str 
      :return: A concatenated integer with s
      :rtype: str
    """
   return str(a_number) + a_string

They should all have a heading describing the functionality and then have a new line then all the parameters. This will help users use our documentation and make things easier.

Oct 08 '24 19:10 isaacmg

Hey @isaacmg i would like to work on this ! could you assign this issue to me ?

Oct 09 '24 03:10 wizaye

Did you get a chance to work on this?

Oct 13 '24 21:10 isaacmg

Hey, I don't this this has been completed. Could this issue be assigned to me, I'd like to contribute to this repo.

Oct 18 '25 14:10 Muqeet-Salam

Okay I just assigned it.

Oct 19 '25 17:10 isaacmg

Hey @isaacmg I just opened a pull req for this issue #879. Please check it out and let me know if I should make any changes.

Oct 22 '25 01:10 Muqeet-Salam

I think with the new PR we can now close this issue.

Oct 23 '25 23:10 isaacmg