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.

Sign up for GitHub

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

Jump to bottom

Docstrings on header #92

Open
YueZhang-studyuse opened this issue Nov 14, 2024 · 1 comment
Open

Docstrings on header #92

YueZhang-studyuse opened this issue Nov 14, 2024 · 1 comment
Assignees
@YueZhang-studyuse
Labels
documentation Improvements or additions to documentation

Comments

@YueZhang-studyuse
Copy link
Collaborator

We need docstrings on the header of the file to improve readability.
@YueZhang-studyuse YueZhang-studyuse added the documentation Improvements or additions to documentation label Nov 14, 2024
@nobodyczcz
Copy link
Collaborator

At top of each file, have a block of string tells what the file is about. Refer to the format. in warthog.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@YueZhang-studyuse YueZhang-studyuse

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nobodyczcz @YueZhang-studyuse