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

add more comments in code #10

Closed
Zhaoyilunnn opened this issue Sep 20, 2023 · 4 comments
Closed

add more comments in code #10

Zhaoyilunnn opened this issue Sep 20, 2023 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Zhaoyilunnn
Copy link
Owner

No description provided.

@Zhaoyilunnn Zhaoyilunnn added the documentation Improvements or additions to documentation label Sep 20, 2023
@Zhaoyilunnn Zhaoyilunnn self-assigned this Sep 20, 2023
@raunakkumarsingh
Copy link
Contributor

Please assign this task to me; I will ensure proper documentation.

@Zhaoyilunnn
Copy link
Owner Author

Hi @raunakkumarsingh, thanks for reaching out. I am willing to assign this task to you, could you please

  1. Try to limit the number of commits and close this issue with a single pull request
  2. If you'd like to add a detailed docstring to a function or class, please follow this standard as we're planing to build documentation website for this project and this can help generate documents easily.

Thanks,

@raunakkumarsingh
Copy link
Contributor

raunakkumarsingh commented Jul 24, 2024

I am following this format:
image

Can I change an already written comment?

@Zhaoyilunnn
Copy link
Owner Author

Zhaoyilunnn commented Jul 25, 2024

I am following this format: image

Yes, google style is exactly what I am looking for

Can I change an already written comment?

Yes of course

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

2 participants