docs/184550: bc -q option not documented in man page

Adam Vande More amvandemore at gmail.com
Sat Dec 7 02:41:31 UTC 2013


On Fri, Dec 6, 2013 at 8:18 PM, Glen Barber <gjb at freebsd.org> wrote:

> On Fri, Dec 06, 2013 at 09:12:30PM -0500, Eitan Adler wrote:
> > all options should be documented.  An undocumented option is a bug.
> > If we don't want people using it we should document as such.
> >
>
> It is documented.
>
>                 case 'q':
>                         /* compatibility option */
>                         break;
>

Source code comments IMO don't qualify for docs.

It should be documented in the man page.  There are plenty of other
examples cite option X is there for compatibility/historical purposes.
 Most users aren't going to review the source code for docs.

-- 
Adam


More information about the freebsd-doc mailing list