Messages in this thread | | | Date | Tue, 7 May 2019 11:38:29 +0200 | From | Johan Hovold <> | Subject | Re: [RFC PATCH 3/5] kobject: Fix kernel-doc comment first line |
| |
On Tue, May 07, 2019 at 09:00:35AM +1000, Tobin C. Harding wrote: > On Fri, May 03, 2019 at 09:56:07AM +0200, Johan Hovold wrote:
> > This isn't about any particular subsystem, but more the tendency of > > people to make up random rules and try to to force it on others. It's > > churn, and also makes things like code forensics and backports harder > > for no good reason. > > Points noted. > > > Both capitalisation styles are about as common for the function > > description judging from a quick grep, but only 10% or so use a full > > stop ('.'). And forcing the use of sentence case and full stop for > > things like > > > > /** > > * maar_init() - Initialise MAARs. > > > > or > > > > * @instr: Operational instruction. > > > > would be not just ugly, but wrong (as these are not independent > > clauses). > > You are correct here.
Actually, I may have been wrong about the first example (imperative), but the second still stands.
> Thanks for taking the time to flesh out your argument Johan, I am now in > agreement with you :)
Good to hear! :)
Johan
| |