Adding a brief overview/Module-level comments at the top of each important .go file #91
Closed
ArmoredArtist
started this conversation in
Ideas
Replies: 2 comments 4 replies
-
Could even add a .txt file to each folder with a brief description of the contents and their purpose for a overall view without opening each file. |
Beta Was this translation helpful? Give feedback.
4 replies
-
Closing this topic for now - eventually I'll have time to expand the documentation... but probably not until development slows down and new features (or major changes to existing code) slow down. This may make a better issue/feature for the future, but I really don't even know what all I want to document before I tackle it. I'll revisit it in 6 months or so. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
It would be helpful to include a brief overview or module-level comments at the top of each important .go file. This could provide context about the purpose and functionality of each file, which might make the code easier to navigate and understand for future contributors.
Beta Was this translation helpful? Give feedback.
All reactions