Use simpara for notes with only one paragraph

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343960 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Jeremy Mikola 2018-01-26 20:52:05 +00:00
parent 562d2000fe
commit 0f19fd56d9
14 changed files with 37 additions and 31 deletions

View file

@ -17,11 +17,11 @@
should be evaluated by the server.
</para>
<note>
<para>
<simpara>
This BSON type is mainly used when executing database commands that take a
Javascript function as a parameter, such as
<link xlink:href="&url.mongodb.docs;reference/command/mapReduce/">mapReduce</link>.
</para>
</simpara>
</note>
</section>
<!-- }}} -->

View file

@ -16,9 +16,9 @@
values.
</para>
<note>
<para>
<simpara>
This is an internal MongoDB type used for indexing and sharding.
</para>
</simpara>
</note>
</section>
<!-- }}} -->

View file

@ -16,9 +16,9 @@
values.
</para>
<note>
<para>
<simpara>
This is an internal MongoDB type used for indexing and sharding.
</para>
</simpara>
</note>
</section>
<!-- }}} -->

View file

@ -26,11 +26,11 @@
information.
</para>
<note>
<para>
<simpara>
Even if <function>MongoDB\BSON\Serializable::bsonSerialize</function> would
return a sequential array, injection of the <property>__pclass</property>
property will cause the object to be serialized as a BSON document.
</para>
</simpara>
</note>
</section>
<!-- }}} -->

View file

@ -16,12 +16,12 @@
<link xlink:href="&url.mongodb.docs.regex;#op._S_options">flags</link>.
</para>
<note>
<para>
<simpara>
This BSON type is mainly used when querying the database. Alternatively,
the
<link xlink:href="&url.mongodb.docs;reference/operator/query/regex">$regex</link>
query operator may be used.
</para>
</simpara>
</note>
</section>
<!-- }}} -->

View file

@ -26,7 +26,9 @@
The regular expression pattern.
</para>
<note>
<para>The pattern should not be wrapped with delimiter characters.</para>
<simpara>
The pattern should not be wrapped with delimiter characters.
</simpara>
</note>
</listitem>
</varlistentry>

View file

@ -22,12 +22,12 @@
from a BSON document.
</para>
<note>
<para>
<simpara>
This method acts as the
<link linkend="language.oop5.decon.constructor">constructor</link> of the
object. The <link linkend="object.construct">__construct()</link> method
will <emphasis>not</emphasis> be called after this method.
</para>
</simpara>
</note>
</refsect1>

View file

@ -184,20 +184,22 @@ object(stdClass)#7 (2) {
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<simpara>
This method does not take a
<classname>MongoDB\Driver\WriteConcern</classname> parameter. For write
commands (e.g.
<link xlink:href="&url.mongodb.docs;reference/command/findAndModify/">findAndModify</link>
in MongoDB 3.2+), the write concern should be included in the
<parameter>command</parameter> document itself.
</para>
<para>
</simpara>
</note>
<note>
<simpara>
If a secondary <parameter>readPreference</parameter> is used, it is the
caller&apos;s responsibility to ensure that the
<parameter>command</parameter> can be executed on a secondary. No validation
is done by the driver.
</para>
</simpara>
</note>
</refsect1>

View file

@ -18,11 +18,11 @@
instances to which this manager is connected.
</para>
<note>
<para>
<simpara>
Since the driver connects to the database lazily, this method may return an
empty <type>array</type> if called before executing an operation on the
<classname>MongoDB\Driver\Manager</classname>.
</para>
</simpara>
</note>
</refsect1>

View file

@ -19,13 +19,13 @@
in order to perform version checking before executing an operation.
</para>
<note>
<para>
<simpara>
Unlike <function>MongoDB\Driver\Manager::getServers</function>, this method
will initialize database connections and perform server discovery if
necessary. See the
<link xlink:href="&url.mongodb.serverselection;#single-threaded-server-selection">Server Selection Specification</link>
for additional information.
</para>
</simpara>
</note>
</refsect1>

View file

@ -19,13 +19,13 @@
several commands at the protocol level.
</para>
<note>
<para>
<simpara>
Since multiple commands may share the same operation ID, it is not reliable
to use this value to associate event objects with each other. The request ID
returned by
<methodname>MongoDB\Driver\Monitoring\CommandFailedEvent::getRequestId</methodname>
should be used instead.
</para>
</simpara>
</note>
</refsect1>

View file

@ -19,13 +19,13 @@
several commands at the protocol level.
</para>
<note>
<para>
<simpara>
Since multiple commands may share the same operation ID, it is not reliable
to use this value to associate event objects with each other. The request ID
returned by
<methodname>MongoDB\Driver\Monitoring\CommandStartedEvent::getRequestId</methodname>
should be used instead.
</para>
</simpara>
</note>
</refsect1>

View file

@ -19,13 +19,13 @@
several commands at the protocol level.
</para>
<note>
<para>
<simpara>
Since multiple commands may share the same operation ID, it is not reliable
to use this value to associate event objects with each other. The request ID
returned by
<methodname>MongoDB\Driver\Monitoring\CommandSucceededEvent::getRequestId</methodname>
should be used instead.
</para>
</simpara>
</note>
</refsect1>

View file

@ -103,19 +103,21 @@
<refsect1 role="notes">
&reftitle.notes;
<note>
<para>
<simpara>
This method does not take a
<classname>MongoDB\Driver\WriteConcern</classname> parameter. For write
commands (e.g.
<link xlink:href="&url.mongodb.docs;reference/command/findAndModify/">findAndModify</link>
in MongoDB 3.2+), the write concern should be included in the
<parameter>command</parameter> document itself.
</para>
<para>
</simpara>
</note>
<note>
<simpara>
It is the caller&apos;s responsibility to ensure that the server is capable
of executing the command. For example, executing a write operation on a
secondary (excluding its "local" database) will fail.
</para>
</simpara>
</note>
</refsect1>