Date: Thu, 13 Oct 2011 22:27:11 -0700 From: Garrett Cooper <yanegomi@gmail.com> To: Warren Block <wblock@wonkity.com> Cc: Niclas Zeising <niclas.zeising@gmail.com>, freebsd-doc@freebsd.org Subject: Re: docs/160696: style(9) should be mentioned in the devs' handbook Message-ID: <CAGH67wQBtWPYKMURtd0mp4HnZC3gn3pg2GHu0wK%2BZjg-DtL5-Q@mail.gmail.com> In-Reply-To: <alpine.BSF.2.00.1110132212210.51180@wonkity.com> References: <201110121030.p9CAUDxd032245@freefall.freebsd.org> <alpine.GSO.1.10.1110132355240.882@multics.mit.edu> <alpine.BSF.2.00.1110132212210.51180@wonkity.com>
next in thread | previous in thread | raw e-mail | index | archive | help
On Thu, Oct 13, 2011 at 9:13 PM, Warren Block <wblock@wonkity.com> wrote: > On Fri, 14 Oct 2011, Benjamin Kaduk wrote: > >> The overall paragraph feels a bit odd, though; maybe like it's written i= n >> a more informal style than I would expect? =A0A more standard dry, techn= ical >> writing version might be: >> %%%%%%%%%% >> <para>When working in a large codebase such as the &os; source, it is >> important to adhere to a common coding style. =A0This provides uniformit= y > > =A0 =A0 =A0 =A0 =A0 =A0 =A0 ^^^^^^ > "conform" might be better here. I'm usually not touchy feely about wording like this, but unless the rest of the document is worded in such a standoffish / cold manner, I would just keep things polite and neutral. "Conform" sounds really pushy and "When working in a..." sounds condescending in my opinion. Saying something like "The &os; project has a number of established procedures, one of which is a common coding style." may or may not be better, as it's common practice for projects to have a style document and this is more or less just serving as a pointer to that documentation. Thanks, -Garrett
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CAGH67wQBtWPYKMURtd0mp4HnZC3gn3pg2GHu0wK%2BZjg-DtL5-Q>