Code Documentation
Date & Time
27 May 2024
Location
Format
In-Person
Language
English
In this session, we will discuss the differences between code commenting and documenting and exchange tips on best practices!
Possible resources to prepare your session’s hack:
- How to write good READMEs for your code repositories to tell others why your project is useful and what they can do with it
- How to write good WIKIs for your projects so that others can use and contribute to your project.
- Python Documentation techniques
Sessions’ agenda:
- Brief round of introductions and description of the problems you’ll be working on during that session
- Formation of possible groups or tandems, if participants have tips to exchange on certain topics
- Hack
- Wrap-up: progress and next steps
Learn more about the Hacky Hour initiative here.
Questions?
If you have any questions, please contact Malika Ihle.