Memory-management documentation and development process

Posted Jun 3, 2023 20:31 UTC (Sat) by atnot (subscriber, #124910)
Parent article: Memory-management documentation and development process

> Pasha Tatashin pointed out that not everybody is a good writer

Perhaps this is because people are not regularly tasked with writing documentation for their code so it is not a skill they hone :)

Either way, I feel like I would much much rather have badly written documentation (or fix badly written documentation) than no documentation at all, just as long as it isn't actively misleading of course?

Memory-management documentation and development process

Posted Jun 4, 2023 14:54 UTC (Sun) by Paf (subscriber, #91811) [Link] (2 responses)

“Document this to land that” still seems likely to feel arbitrary and burdensome to me?

Memory-management documentation and development process

Posted Jun 6, 2023 23:14 UTC (Tue) by mathstuf (subscriber, #69389) [Link] (1 responses)

There are expectations that those climbing Mt. Everest bring back at least a certain amount of trash (beyond their own) on their way back (I believe implemented via a returnable portion of the permit fee). I don't see how asking for some drive-by doc updates is that much different.

Memory-management documentation and development process

Posted Jun 6, 2023 23:56 UTC (Tue) by Wol (subscriber, #4433) [Link]

Or even just say you can't land a code upodate without also landing appropriate documentation.

If the documentation has to document the modified code, plus anything close enough to be needed for understanding, then the documentation coverage will grow faster than the code. You can't ask for much more.

Cheers,
Wol