On 08/29/2018 01:54 PM, Paul E. McKenney wrote: > On Tue, Aug 28, 2018 at 04:01:50PM -0700, Andrew Morton wrote: >> Another pet peeve ;) >> >> On Tue, 28 Aug 2018 13:19:40 -0400 Waiman Long <longman@xxxxxxxxxx> wrote: >> >>> /** >>> + * list_lru_add_head: add an element to the lru list's head >>> + * @list_lru: the lru pointer >>> + * @item: the item to be added. >>> + * >>> + * This is similar to list_lru_add(). The only difference is the location >>> + * where the new item will be added. The list_lru_add() function will add >> People often use the term "the foo() function". I don't know why - >> just say "foo()"! > For whatever it is worth... > > I tend to use "The foo() function ..." instead of "foo() ..." in order > to properly capitalize the first word of the sentence. So I might say > "The call_rcu() function enqueues an RCU callback." rather than something > like "call_rcu() enqueues an RCU callback." Or I might use some other > trick to keep "call_rcu()" from being the first word of the sentence. > But if the end of the previous sentence introduced call_rcu(), you > usually want the next sentence's first use of "call_rcu()" to be very > early in the sentence, because otherwise the flow will seem choppy. > > And no, I have no idea what I would do if I were writing in German, > where nouns are capitalized, given that function names tend to be used > as nouns. Probably I would get yelled at a lot for capitalizing my > function names. ;-) > > Thanx, Paul > Yes, doing proper capitalization of the first letter of a sentence is the main reason I used "The foo() function" in a sentence. Cheers, Longman
