[Maintain-dev] Fw: Typos in the standards.txt documentation
Josh Schonstal
schonstal at osuosl.org
Wed Jan 31 13:26:39 PST 2007
The current trunk is at version 3.1; however, the problem has been noted
and will be fixed.
Edward Lim wrote:
>
> ------------------------------------------------------------------------
>
> Subject:
> Typos in the standards.txt documentation
> Date:
> Sun, 28 Jan 2007 19:03:53 -0800
> To:
> maintain-dev at lists.osuosl.org
>
> To:
> maintain-dev at lists.osuosl.org
>
>
> The standards.txt file has a typo in it. Instead of maintain 3.0 its stated
> as maintain 2.6 in the documentation. I edited it and i'm submitting this
> patch to you guys
>
> Ed
>
> ------------------------------------------------------------------------
>
> --- standards.new.txt 2007-01-28 18:58:23.847716000 -0800
> +++ standards.txt 2007-01-28 18:58:43.835468000 -0800
> @@ -26,7 +26,7 @@
> -----------
> Please consult the documentation regarding the source code layout to guide you
> on where your code belongs in the tree and how to properly lay it out. Since
> -Maintain 3.0, there has been a rigid structure defining the proper layout of
> +Maintain 2.6, there has been a rigid structure defining the proper layout of
> code within the source tree.
>
> [[text]]
> @@ -77,7 +77,7 @@
> [[doc]]
> Documentation
> -------------
> -Maintain 3.0 now uses phpDocumentor (phpdoc) for API documentation. All
> +Maintain 2.6 now uses phpDocumentor (phpdoc) for API documentation. All
> classes in Maintain are required to use phpdoc for clarity and to assist other
> programmers. More information on phpDocumentor can be found
> link:http://www.phpdoc.org/[at http://www.phpdoc.org/].
> @@ -108,7 +108,7 @@
> [[packages]]
> Packages
> ^^^^^^^^
> -The Maintain 3.0 API is split into distinct packages and subpackages that
> +The Maintain 2.6 API is split into distinct packages and subpackages that
> roughtly follow the directory structure. The hierarchy looks something as
> follows (all names are strictly lower-cased):
>
> @@ -147,7 +147,7 @@
> link:http://pear.php.net/manual/en/standards.php[PEAR coding standards].
>
> .Capitalization
> -Although Maintain 3.0 is a PHP4 application, the code is becoming increasingly
> +Although Maintain 2.6 is a PHP4 application, the code is becoming increasingly
> object-oriented. As such, we are using nerdyCaps for long variable, method,
> and class names. PHP files containing classes should be cased in the Java
> style, i.e. a file containing the class `myClass` should be named `MyClass.php`
>
> ------------------------------------------------------------------------
>
> _______________________________________________
> Maintain-dev mailing list
> Maintain-dev at lists.osuosl.org
> http://lists.osuosl.org/mailman/listinfo/maintain-dev
>
More information about the Maintain-dev
mailing list