This is the mail archive of the
mailing list for the libstdc++ project.
Re: [libstdc++ patch] : fix typos in Doxygen comments
- From: Jonathan Wakely <cow at compsoc dot man dot ac dot uk>
- To: libstdc++ at gcc dot gnu dot org
- Cc: Sylvain Pion <Sylvain dot Pion at mpi-sb dot mpg dot de>
- Date: Mon, 23 Dec 2002 15:36:24 +0000
- Subject: Re: [libstdc++ patch] : fix typos in Doxygen comments
- References: <20021220170603.C10073@mpii01005.mpi-sb.mpg.de>
On Fri, Dec 20, 2002 at 05:06:03PM +0100, Sylvain Pion wrote:
> Index: libstdc++-v3/include/bits/stl_deque.h
> RCS file: /cvs/gcc/gcc/libstdc++-v3/include/bits/stl_deque.h,v
> retrieving revision 1.31
> diff -u -r1.31 stl_deque.h
> --- libstdc++-v3/include/bits/stl_deque.h 16 Dec 2002 18:22:59 -0000 1.31
> +++ libstdc++-v3/include/bits/stl_deque.h 20 Dec 2002 15:57:59 -0000
> @@ -1549,12 +1549,12 @@
> * @brief Deque ordering relation.
> * @param x A %deque.
> * @param y A %deque of the same type as @a x.
> - * @return True iff @a x is lexographically less than @a y.
> + * @return True iff @a x is lexicographically less than @a y.
This patch reminded me of something I've been meaning to ask.
Is the term "iff" known widely enough to use in the libstdc++ docs?
Not all readers will have a background in logic or logical fields,
and might assume it's just a typo for "if".
Would "True if ..., false otherwise" be clear for all readers?
Just a thought.
> * This is a total ordering relation. It is linear in the size of the
> * deques. The elements must be comparable with @c <.
> - * See std::lexographical_compare() for how the determination is made.
> + * See std::lexicographical_compare() for how the determination is made.
"Live fast, die old, and make very sure everyone knows you were there."
- Alan Cox