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

DOCUMENTATION: add package level documentation and files level documentation for all files #5

Open
elrayle opened this issue Sep 5, 2022 · 0 comments
Open

DOCUMENTATION: add package level documentation and files level documentation for all files #5

elrayle opened this issue Sep 5, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@elrayle
Copy link
Collaborator

elrayle commented Sep 5, 2022 •
edited
Loading

Add documentation explaining major concepts and purpose for each file.

Add package level documentation that describes interconnections between major concepts in different files and how to use public API.

_NOTE: Use Go for identifying the go language. There is at least one use of GO in the code documentation.`
@elrayle elrayle mentioned this issue Sep 5, 2022
Merged
@elrayle elrayle added the documentation Improvements or additions to documentation label Oct 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@elrayle