Jonathan Cameron <[email protected]> writes: > On Wed, 01 Feb 2023 13:14:06 +0100 > Markus Armbruster <[email protected]> wrote:
[...] >> Both commit message and doc comment are rather terse. >> >> The commit message should make the case for the feature: why do we want >> it? This typically involves explaining the problem(s) it solves. >> >> The doc comment ideally explains intended use. > > OK. I'll expand on this. It'll be a bit of fuzzy text that > boils down to we emulate so we can test the OS does the right thing > when it gets poison related events. I can add some generic fluff on > why a real device might implement this in the first place though > I'm not sure that will even matter to anyone reading these docs. Use your judgement :)
