Ok, look, if you have an open source tool that became even remotely popular then please, I am honestly begging you: go back into your source code and document every single algorithm extensively. Explain every single line, every single function call. Please.
-
Show this thread
-
I know we all end up pushing code to GitHub that is underdocumented sometimes, and we're all a bit embarrassed by it, but if that code gains attention you need to realize that one day someone will use your popular code as reference material.
1 reply 0 retweets 4 likesShow this thread -
2 hours of your time to add basic documentation could save people in the future days or even weeks of work figuring out your recursive xor algorithm.
1 reply 0 retweets 5 likesShow this thread -
Got a huge table of constants that you're using to linearize intensive math via LUTs? Smart! Tell other people how you generated said table and what it replaces so that they can replicate said work.
1 reply 0 retweets 4 likesShow this thread -
Got a weird recursive function? Show people what a starting call looks like and how the call changes with increasing recursion depth, with constants in place of variables.
1 reply 0 retweets 5 likesShow this thread -
The long and short of it is that it will always take you, the original dev, 1/10th to 1/100th of the time it would take some learning dev to understand and document what you did. Save them some time as thanks for all the time someone did it for you. Let's develop better together.
3 replies 1 retweet 9 likesShow this thread
Is this an acceptable alternative? /* I have no idea what I was thinking when I wrote this code. Run away now, before it's too late! */
-
-
Replying to @David3141593
Yeah tbh I'd rather read that and know not to try
0 replies 0 retweets 0 likesThanks. Twitter will use this to make your timeline better. UndoUndo
-
Loading seems to be taking a while.
Twitter may be over capacity or experiencing a momentary hiccup. Try again or visit Twitter Status for more information.