cvs: peardoc /en/chapters standards.xml
| From: | Daniel Convissor | Date: | Wed, 12 May 2004 22:13:15 +0000 |
| Subject: | cvs: peardoc /en/chapters standards.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-3962@lists.php.net to get a copy of this message | ||
danielc Wed May 12 18:13:15 2004 EDT
Modified files:
/peardoc/en/chapters standards.xml
Log:
Replace double quotes with other entities.
http://cvs.php.net/diff.php/peardoc/en/chapters/standards.xml?r1=1.14&r2=1.15&ty=u
Index: peardoc/en/chapters/standards.xml
diff -u peardoc/en/chapters/standards.xml:1.14 peardoc/en/chapters/standards.xml:1.15
--- peardoc/en/chapters/standards.xml:1.14 Wed May 12 18:01:31 2004
+++ peardoc/en/chapters/standards.xml Wed May 12 18:13:12 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1" ?>
-<!-- $Revision: 1.14 $ -->
+<!-- $Revision: 1.15 $ -->
<chapter id="standards">
<title>Coding Standards</title>
@@ -118,7 +118,8 @@
<sect1 id="standards.funcdef">
<title>Function Definitions</title>
<para>
- Function declarations follow the "one true brace" convention:
+ Function declarations follow the <quote>one true brace</quote>
+ convention:
<programlisting role="php">
function fooFunction($arg1, $arg2 = '')
{
@@ -161,8 +162,9 @@
</para>
<para>
Non-documentation comments are strongly encouraged. A general rule of
- thumb is that if you look at a section of code and think "Wow, I don't
- want to try and describe that", you need to comment it before you
+ thumb is that if you look at a section of code and think
+ <quote>Wow, I don't want to try and describe that</quote>,
+ you need to comment it before you
forget how it works.
</para>
<para>
@@ -233,7 +235,7 @@
<para>
There's no hard rule to determine when a new code contributor
should be added to the list of authors for a given source file.
- In general, their changes should fall into the "substantial"
+ In general, their changes should fall into the <quote>substantial</quote>
category (meaning somewhere around 10% to 20% of code changes).
Exceptions could be made for rewriting functions or contributing
new logic.
@@ -257,7 +259,7 @@
<para>
Include the $Id$ CVS keyword in each file. As each file
is edited, add this tag if it's not yet present (or replace
- existing forms such as "Last Modified:", etc.).
+ existing forms such as <quote>Last Modified:</quote>, etc.).
<!--
<note>
<simpara>
@@ -305,7 +307,8 @@
<term>MAINT_<replaceable>n_n_n</replaceable></term>
<listitem>
<simpara>
- (branch, optional) If you need to make "micro-releases" (for
+ (branch, optional) If you need to make
+ <quote>micro-releases</quote> (for
example 1.2.1 and so on after 1.2.0), you can use a branch for
that too, if your main trunk is very active and you want only
minor changes between your micro-releases.
@@ -318,7 +321,7 @@
</para>
<para>
Below is an example of how to tag the 1.2 release of the
- "Money_Fast" package:
+ <classname>Money_Fast</classname> package:
<informalexample>
<screen><prompt>$ </prompt><command>cd pear/Money_Fast</command>
<prompt>$ </prompt><command>cvs tag RELEASE_1_2</command>
@@ -343,7 +346,8 @@
<prompt>$ </prompt><command>cvs tag RELEASE_2_0_0</command>
</screen>
</informalexample>
- The "QA_2_0_0_BP" tag is a "branch point" tag, which is the start
+ The <literal>QA_2_0_0_BP</literal> tag is a
+ <quote>branch point</quote> tag, which is the start
point of the tag. It's always a good idea to start a CVS branch
from such branch points. MAINT branches may use the RELEASE tag
as their branch point.
@@ -353,7 +357,8 @@
<sect1 id="standards.exampleurls">
<title>Example URLs</title>
<para>
- Use "example.com", "example.org" and "example.net" for all
example URLs
+ Use <literal>example.com</literal>, <literal>example.org</literal>
+ and <literal>example.net</literal> for all example URLs
and email addresses, per <ulink url="&url.rfc;2606">RFC 2606</ulink>.
</para>
</sect1>
@@ -384,12 +389,13 @@
<sect2>
<title>Functions and Methods</title>
<para>
- Functions and methods should be named using the "studly caps"
- style (also referred to as "bumpy case" or "camel caps").
+ Functions and methods should be named using the
+ <quote>studly caps</quote> style (also referred to as
+ <quote>bumpy case</quote> or <quote>camel caps</quote>).
Functions should in addition have the package name as a prefix,
to avoid name collisions between packages. The initial letter of
the name (after the prefix) is lowercase, and each letter that
- starts a new "word" is capitalized. Some examples:
+ starts a new <quote>word</quote> is capitalized. Some examples:
<informaltable>
<tgroup cols="4">
<tbody>
@@ -428,7 +434,7 @@
separate words. Prefix constant names with the uppercased name
of the class/package they are used in. For example, the constants
used by the <literal>DB::</literal> package all begin with
- "<literal>DB_</literal>".
+ <literal>DB_</literal>.
</para>
</sect2>
<sect2>
@@ -494,7 +500,7 @@
// | Your Name <you@example.com> |
// +----------------------------------------------------------------------+
//
-// $Id: standards.xml,v 1.14 2004/05/12 22:01:31 danielc Exp $
+// $Id: standards.xml,v 1.15 2004/05/12 22:13:12 danielc Exp $
require_once 'PEAR.php';
@@ -546,7 +552,7 @@
* @category categoryname
* @package packagename
* @author Original Author <author@example.com>
- * @version $Id: standards.xml,v 1.14 2004/05/12 22:01:31 danielc Exp $
+ * @version $Id: standards.xml,v 1.15 2004/05/12 22:13:12 danielc Exp $
* @access public
* @see NetOther, Net_Sample::Net_Sample()
* @since Class available since Release 1.2.0