Comment on Algorithms instead of source code !!
justJanne@startrek.website 8 months ago
Considering that reading source code can take a long time
You’ll get faster over time, until reading code is faster than reading documentation, as code will always represent what’s truly happening, while docs are frequently outdated.
In a language the user isn’t familiar with
If you’re not that familiar, it’s likely you won’t be contributing to the project. Open source projects usually to have quite limited resources, so they tend to optimize docs and dev UX for people who are likely to contribute.
erranto@lemmy.world 8 months ago
You can still borrow and implement features developed by project x into project y , but I do understand the time limitation.
because I am more of a visual learner I wondered whether developers don’t use diagrams and flow charts, or just don’t include them in the docs.
YIj54yALOJxEsY20eU@lemm.ee 8 months ago
Personally I will jot some loose notes down if I’m implementing something that requires it, but formalizing the design patterns/algorithms is very time consuming so I don’t.