Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update all docstrings to be ReadTheDocs compatible and fill in missing docstrings #803

Open
isaacmg opened this issue Oct 8, 2024 · 2 comments
Assignees

Comments

@isaacmg
Copy link
Collaborator

isaacmg commented Oct 8, 2024

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.

@wizaye
Copy link

wizaye commented Oct 9, 2024

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

@isaacmg
Copy link
Collaborator Author

isaacmg commented Oct 13, 2024

Did you get a chance to work on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants