[project @ 2001-07-03 09:21:46 by simonmar]

Add a paragraph on when to pluralize(*) a module name

(*) it's a word, I checked

diff --git a/doc/libraries.sgml b/doc/libraries.sgml
index e1155e0..742bc80 100644 (file)
--- a/doc/libraries.sgml
+++ b/doc/libraries.sgml
@@ -677,7 +677,7 @@
 -- Stability   :  experimental | provisional | stable
 -- Portability :  portable | non-portable (<replaceable>reason(s)</replaceable>)
 --
 -- Stability   :  experimental | provisional | stable
 -- Portability :  portable | non-portable (<replaceable>reason(s)</replaceable>)
 --

--- $Id: libraries.sgml,v 1.2 2001/07/03 09:02:05 simonmar Exp $
+-- $Id: libraries.sgml,v 1.3 2001/07/03 09:21:46 simonmar Exp $

 --
 -- <replaceable>Description</replaceable>
 -----------------------------------------------------------------------------
 --
 -- <replaceable>Description</replaceable>
 -----------------------------------------------------------------------------

@@ -687,7 +687,7 @@
 
       <variablelist>
        <varlistentry>
 
       <variablelist>
        <varlistentry>

-         <term><literal>$Id: libraries.sgml,v 1.2 2001/07/03 09:02:05 simonmar Exp $</literal></term>
+         <term><literal>$Id: libraries.sgml,v 1.3 2001/07/03 09:21:46 simonmar Exp $</literal></term>

          <listitem>
            <para>is optional, but usually included if the module is
            under CVS or RCS control.</para>
          <listitem>
            <para>is optional, but usually included if the module is
            under CVS or RCS control.</para>

@@ -822,6 +822,15 @@ import Text.Html.Internals -- The non-abstract library (for building other libs)
            valid words, and are more often used as such.</para>
          </listitem>
 
            valid words, and are more often used as such.</para>
          </listitem>
 

+         <listitem>
+           <para>A module name should be made plural only if the
+           module actually defines multiple entities of a particular
+           kind: eg. <literal>Foreign.C.Types</literal>.  Most module
+           names which define a type or class will follow the name of
+           the type or class, so whether to pluralize is not an
+           issue.</para>
+         </listitem>
+

        </itemizedlist>
       </sect3>
 
        </itemizedlist>
       </sect3>