[Rpm-maint] [rpm-software-management/rpm] Avoid incrementing a pointer past the end (#1489)

[Panu Matilainen]

Public API docs are documentation, not comments, despite masquerading as such.

Multiline comments are by no means forbidden, just that they should be used sparingly, in particular in middle of code. In middle of code, multiline comments are very distracting so they should only be used there when it's in fact the *purpose* to distract, typically to deliver a warning of some sort.
https://www.kernel.org/doc/html/v5.11/process/coding-style.html#commenting is excellent advice (most of the kernel coding style is, despite some details such as indentation differing a bit)

The general preference is do the explaining in the code itself, using descriptive names and that in the best cases make the code read almost like a story. Clearly not all of rpm is that way :rofl: and it's not always achievable now matter what, but hey, it's a goal.

-- 
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/rpm-software-management/rpm/pull/1489#issuecomment-781184122
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rpm.org/pipermail/rpm-maint/attachments/20210218/c289a317/attachment.html>