document your codeeeee

thumb
km0 1 year ago
parent 7a2578fecf
commit e6580d2f45

@ -87,20 +87,18 @@ but this will be for another time
### Let's write some text!!
points to touch on:
- code documentation
- couple of hours
- not just your code
Let's write some code documentation! For your new coding project, for the cryptic library you downloaded recently, for a script you want to share with others!
Let's write some code documentation! For your new coding project, for the cryptic library you downloaded recently, for a script that you want to share with others!
Too many pieces of code are left alone out there: without an entry point, invisible, while outside is raining
Too many pieces of code are left alone out there: without an entry point, forgotten, while outside is raining. Wouldn't it be nice to take care of them?
Enter the documentation sessions. Two hours where to sit with source code and write something about it. From simple instructions to in-depth explanations, or maybe some drawings to illustrate the overall process. You name it.
Writing documentation is difficult! But let's face this together: prompts and suggestions will be offered for inspiration, and coffee and snacks for restoration. If you want there will be space to share your work and exchange feedback, if not no prob: just enjoy the cozy music and write some docs.
It's so nice when explanation of how a script works: wouldn't be great to take care
- notes for thesis: cycling along the river, documentation, learning a new language, esolang, exploring different ways of thinking
__Practical info:__
Two hours on Thursday afternoon, on a regular basis!
For people that thinkers with code, no matter the experience.
Processing, P5.js, TouchDesigner, Javascript, Python, doesn't really matter! All code looks better when is documented!

Loading…
Cancel
Save