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 Docstrings to Follow NumPy Convention #125

Closed
ldr426 opened this issue Jul 13, 2023 · 0 comments
Closed

Update Docstrings to Follow NumPy Convention #125

ldr426 opened this issue Jul 13, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@ldr426
Copy link
Collaborator

ldr426 commented Jul 13, 2023

As @leewujung proposes in #122 (comment), we should update the docstrings in our project to adhere to the NumPy docstring convention. This will help improve consistency and readability in our documentation.

To avoid making this issue too large, I suggest creating a separate issue specifically for addressing the docstring convention. This can be tackled when we want to take a break from the histogram functionality.

Here's a suggested approach:

  • Make all new docstrings in the histogram functionality PR in the numpy docstring style
  • Create a separate PR for all other parts of the codebase to update their docstrings to the NumPy style convention.

Originally posted by @leewujung in #122 (comment)

@ldr426 ldr426 added the documentation Improvements or additions to documentation label Jul 13, 2023
@ldr426 ldr426 mentioned this issue Jul 13, 2023
@ldr426 ldr426 closed this as completed Aug 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant