diff --git a/lib_guide.htm b/lib_guide.htm index a438a41..20487fe 100644 --- a/lib_guide.htm +++ b/lib_guide.htm @@ -421,12 +421,12 @@ Automatic redirection failed, please go to
As library developers and users have gained experience with Boost, the following consistent naming approach has come to be viewed as very helpful, - particularly for larger libraries which need their own header subdirectories + particularly for larger libraries that need their own header subdirectories and namespaces.
-Here is how it works. The library is given a name which describes the contents - of the library. Cryptic abbreviations are not acceptable. Following the +
Here is how it works. The library is given a name that describes the contents + of the library. Cryptic abbreviations are strongly discouraged. Following the practice of the C++ Standard Library, names are usually singular rather than - plural. For example, a library dealing with file systems might chose the + plural. For example, a library dealing with file systems might chose the name "filesystem", but not "filesystems", "fs" or "nicecode".
When documenting Boost libraries, follow these conventions (see also the following section of this document): +
Here are a few examples of how to apply these conventions: +
Even the simplest library needs some documentation; the amount should be proportional to the need. The documentation should assume the readers