Skip to content

Commit bfed2a1

Browse files
PhilDaiguillePhilDaiguille
authored
Update XML documentation for MongoDB methods to enhance clarity and consistency (#600)
1 parent ae6961f commit bfed2a1

50 files changed

Lines changed: 922 additions & 955 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎reference/mongodb/bson/utcdatetimeinterface/tostring.xml‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -36,23 +36,23 @@
3636

3737
</refentry>
3838

39-
<!-- Keep this comment at the end of the file
40-
Local variables:
41-
mode: sgml
42-
sgml-omittag:t
43-
sgml-shorttag:t
44-
sgml-minimize-attributes:nil
45-
sgml-always-quote-attributes:t
46-
sgml-indent-step:1
47-
sgml-indent-data:t
48-
indent-tabs-mode:nil
49-
sgml-parent-document:nil
50-
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
51-
sgml-exposed-tags:nil
52-
sgml-local-catalogs:nil
53-
sgml-local-ecat-files:nil
54-
End:
55-
vim600: syn=xml fen fdm=syntax fdl=2 si
56-
vim: et tw=78 syn=sgml
57-
vi: ts=1 sw=1
58-
-->
39+
<!-- Keep this comment at the end of the file
40+
Local variables:
41+
mode: sgml
42+
sgml-omittag:t
43+
sgml-shorttag:t
44+
sgml-minimize-attributes:nil
45+
sgml-always-quote-attributes:t
46+
sgml-indent-step:1
47+
sgml-indent-data:t
48+
indent-tabs-mode:nil
49+
sgml-parent-document:nil
50+
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
51+
sgml-exposed-tags:nil
52+
sgml-local-catalogs:nil
53+
sgml-local-ecat-files:nil
54+
End:
55+
vim600: syn=xml fen fdm=syntax fdl=2 si
56+
vim: et tw=78 syn=sgml
57+
vi: ts=1 sw=1
58+
-->

‎reference/mongodb/mongodb/driver/bulkwritecommandresult/getinsertresults.xml‎

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: 187032b3ea20fa28f1c9f29ba38d06820428f849 Maintainer: PhilDaiguille Status: ready -->
3-
<!-- Reviewed: yes -->
4-
2+
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: PhilDaiguille Status: ready -->
3+
<!-- Reviewed: no -->
54
<refentry xml:id="mongodb-driver-bulkwritecommandresult.getinsertresults" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
65
<refnamediv>
76
<refname>MongoDB\Driver\BulkWriteCommandResult::getInsertResults</refname>
8-
<refpurpose>Devuelve los resultados detallados de las inserciones exitosas</refpurpose>
7+
<refpurpose>Devuelve resultados detallados para las inserciones exitosas</refpurpose>
98
</refnamediv>
109

1110
<refsect1 role="description">
@@ -14,13 +13,13 @@
1413
<modifier>final</modifier> <modifier>public</modifier> <type class="union"><type>MongoDB\BSON\Document</type><type>null</type></type><methodname>MongoDB\Driver\BulkWriteCommandResult::getInsertResults</methodname>
1514
<void />
1615
</methodsynopsis>
17-
<para>
18-
Dado que los campos <literal>_id</literal> de los documentos insertados son generados por
19-
la extensión, el valor de <literal>insertedId</literal> en cada resultado
20-
corresponderá al valor de retorno de
16+
<simpara>
17+
Dado que los campos <literal>_id</literal> para los documentos insertados son
18+
generados por la extensión, el valor de <literal>insertedId</literal> en cada
19+
resultado coincidirá con el valor de retorno de
2120
<methodname>MongoDB\Driver\BulkWriteCommand::insertOne</methodname> para
2221
la operación de inserción correspondiente.
23-
</para>
22+
</simpara>
2423
</refsect1>
2524

2625
<refsect1 role="parameters">
@@ -30,12 +29,12 @@
3029

3130
<refsect1 role="returnvalues">
3231
&reftitle.returnvalues;
33-
<para>
34-
Devuelve un documento que contiene los resultados de cada operación de inserción
35-
o &null; si los resultados detallados no fueron solicitados. Las claves
36-
del documento corresponderán al índice de la operación de escritura de
32+
<simpara>
33+
Devuelve un documento que contiene el resultado de cada operación de inserción
34+
exitosa, o &null; si no se solicitaron resultados detallados. Las claves del
35+
documento corresponderán al índice de la operación de escritura de
3736
<classname>MongoDB\Driver\BulkWriteCommand</classname>.
38-
</para>
37+
</simpara>
3938
</refsect1>
4039

4140
<refsect1 role="errors">

‎reference/mongodb/mongodb/driver/bulkwritecommandresult/getmatchedcount.xml‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: 187032b3ea20fa28f1c9f29ba38d06820428f849 Maintainer: PhilDaiguille Status: ready -->
3-
<!-- Reviewed: yes -->
4-
2+
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: PhilDaiguille Status: ready -->
3+
<!-- Reviewed: no -->
54
<refentry xml:id="mongodb-driver-bulkwritecommandresult.getmatchedcount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
65
<refnamediv>
76
<refname>MongoDB\Driver\BulkWriteCommandResult::getMatchedCount</refname>
8-
<refpurpose>Devuelve el número de documentos seleccionados para la actualización</refpurpose>
7+
<refpurpose>Devuelve el número de documentos seleccionados para actualización</refpurpose>
98
</refnamediv>
109

1110
<refsect1 role="description">
@@ -14,12 +13,12 @@
1413
<modifier>final</modifier> <modifier>public</modifier> <type>int</type><methodname>MongoDB\Driver\BulkWriteCommandResult::getMatchedCount</methodname>
1514
<void />
1615
</methodsynopsis>
17-
<para>
18-
Si la operación de actualización no realiza ningún cambio en el documento (por ejemplo, al
19-
definir el valor de un campo a su valor actual), el número de documentos puede ser mayor
20-
que el valor devuelto por
16+
<simpara>
17+
Si la operación de actualización no produce cambios en el documento (por ejemplo,
18+
establecer el valor de un campo a su valor actual), el conteo de coincidencias puede ser
19+
mayor que el valor devuelto por
2120
<methodname>MongoDB\Driver\BulkWriteCommandResult::getModifiedCount</methodname>.
22-
</para>
21+
</simpara>
2322
</refsect1>
2423

2524
<refsect1 role="parameters">
@@ -29,9 +28,9 @@
2928

3029
<refsect1 role="returnvalues">
3130
&reftitle.returnvalues;
32-
<para>
33-
Devuelve el número total de documentos seleccionados para la actualización por todas las operaciones.
34-
</para>
31+
<simpara>
32+
Devuelve el número total de documentos seleccionados para actualización por todas las operaciones.
33+
</simpara>
3534
</refsect1>
3635

3736
<refsect1 role="errors">

‎reference/mongodb/mongodb/driver/bulkwritecommandresult/getmodifiedcount.xml‎

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: 187032b3ea20fa28f1c9f29ba38d06820428f849 Maintainer: PhilDaiguille Status: ready -->
3-
<!-- Reviewed: yes -->
4-
2+
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: PhilDaiguille Status: ready -->
3+
<!-- Reviewed: no -->
54
<refentry xml:id="mongodb-driver-bulkwritecommandresult.getmodifiedcount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
65
<refnamediv>
76
<refname>MongoDB\Driver\BulkWriteCommandResult::getModifiedCount</refname>
8-
<refpurpose>Devuelve el número de documentos existentes actualizados</refpurpose>
7+
<refpurpose>Devuelve el número de documentos existentes que se actualizaron</refpurpose>
98
</refnamediv>
109

1110
<refsect1 role="description">
@@ -14,12 +13,12 @@
1413
<modifier>final</modifier> <modifier>public</modifier> <type>int</type><methodname>MongoDB\Driver\BulkWriteCommandResult::getModifiedCount</methodname>
1514
<void />
1615
</methodsynopsis>
17-
<para>
18-
Si la operación de actualización no realiza ningún cambio en el documento (por ejemplo, al
19-
establecer el valor de un campo a su valor actual), el número de documentos puede ser menor
20-
que el valor devuelto por
16+
<simpara>
17+
Si la operación de actualización no produce cambios en el documento (por ejemplo,
18+
establecer el valor de un campo a su valor actual), el recuento de documentos
19+
modificados puede ser menor que el valor devuelto por
2120
<methodname>MongoDB\Driver\BulkWriteCommandResult::getMatchedCount</methodname>.
22-
</para>
21+
</simpara>
2322
</refsect1>
2423

2524
<refsect1 role="parameters">
@@ -29,9 +28,10 @@
2928

3029
<refsect1 role="returnvalues">
3130
&reftitle.returnvalues;
32-
<para>
33-
Devuelve el número total de documentos existentes actualizados por todas las operaciones.
34-
</para>
31+
<simpara>
32+
Devuelve el número total de documentos existentes que fueron actualizados por
33+
todas las operaciones.
34+
</simpara>
3535
</refsect1>
3636

3737
<refsect1 role="errors">
@@ -53,6 +53,7 @@
5353
$manager = new MongoDB\Driver\Manager;
5454
5555
$bulk = new MongoDB\Driver\BulkWriteCommand;
56+
$bulk->insertOne('db.coll', ['x' => 1]);
5657
$bulk->updateOne('db.coll', ['x' => 1], ['$set' => ['y' => 3]]);
5758
$bulk->updateOne('db.coll', ['x' => 2], ['$set' => ['y' => 1]], ['upsert' => true]);
5859
$bulk->updateOne('db.coll', ['x' => 3], ['$set' => ['y' => 2]], ['upsert' => true]);

‎reference/mongodb/mongodb/driver/bulkwritecommandresult/getupdateresults.xml‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: 187032b3ea20fa28f1c9f29ba38d06820428f849 Maintainer: PhilDaiguille Status: ready -->
3-
<!-- Reviewed: yes -->
4-
2+
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: PhilDaiguille Status: ready -->
3+
<!-- Reviewed: no -->
54
<refentry xml:id="mongodb-driver-bulkwritecommandresult.getupdateresults" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
65
<refnamediv>
76
<refname>MongoDB\Driver\BulkWriteCommandResult::getUpdateResults</refname>
8-
<refpurpose>Devuelve los resultados detallados de las actualizaciones exitosas</refpurpose>
7+
<refpurpose>Devuelve resultados detallados para las actualizaciones exitosas</refpurpose>
98
</refnamediv>
109

1110
<refsect1 role="description">
@@ -14,8 +13,8 @@
1413
<modifier>final</modifier> <modifier>public</modifier> <type class="union"><type>MongoDB\BSON\Document</type><type>null</type></type><methodname>MongoDB\Driver\BulkWriteCommandResult::getUpdateResults</methodname>
1514
<void />
1615
</methodsynopsis>
17-
<para>
18-
</para>
16+
<simpara>
17+
</simpara>
1918
</refsect1>
2019

2120
<refsect1 role="parameters">
@@ -25,12 +24,12 @@
2524

2625
<refsect1 role="returnvalues">
2726
&reftitle.returnvalues;
28-
<para>
29-
Devuelve un documento que contiene los resultados de cada operación de actualización
30-
exitosa, o &null; si los resultados detallados no fueron solicitados. Las claves
31-
del documento corresponderán al índice de la operación de escritura de
27+
<simpara>
28+
Devuelve un documento que contiene el resultado de cada operación de actualización
29+
exitosa, o &null; si no se solicitaron resultados detallados. Las claves del documento
30+
corresponderán al índice de la operación de escritura de
3231
<classname>MongoDB\Driver\BulkWriteCommand</classname>.
33-
</para>
32+
</simpara>
3433
</refsect1>
3534

3635
<refsect1 role="errors">
@@ -113,7 +112,7 @@ object(stdClass)#16 (3) {
113112
string(1) "0"
114113
}
115114
["upsertedId"]=>
116-
object(MongoDB\BSON\ObjectId)#14 (1) {
115+
object(MongoDB\BSON\Int64)#14 (1) {
117116
["oid"]=>
118117
string(24) "67f7eb9b1f198bbcb880d576"
119118
}

‎reference/mongodb/mongodb/driver/bulkwritecommandresult/getupsertedcount.xml‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: 187032b3ea20fa28f1c9f29ba38d06820428f849 Maintainer: PhilDaiguille Status: ready -->
3-
<!-- Reviewed: yes -->
4-
2+
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: PhilDaiguille Status: ready -->
3+
<!-- Reviewed: no -->
54
<refentry xml:id="mongodb-driver-bulkwritecommandresult.getupsertedcount" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
65
<refnamediv>
76
<refname>MongoDB\Driver\BulkWriteCommandResult::getUpsertedCount</refname>
8-
<refpurpose>Devuelve el número de documentos insertados/actualizados</refpurpose>
7+
<refpurpose>Devuelve el número de documentos insertados o actualizados (upserted)</refpurpose>
98
</refnamediv>
109

1110
<refsect1 role="description">
@@ -14,8 +13,8 @@
1413
<modifier>final</modifier> <modifier>public</modifier> <type>int</type><methodname>MongoDB\Driver\BulkWriteCommandResult::getUpsertedCount</methodname>
1514
<void />
1615
</methodsynopsis>
17-
<para>
18-
</para>
16+
<simpara>
17+
</simpara>
1918
</refsect1>
2019

2120
<refsect1 role="parameters">
@@ -25,9 +24,9 @@
2524

2625
<refsect1 role="returnvalues">
2726
&reftitle.returnvalues;
28-
<para>
29-
Devuelve el número total de documentos insertados/actualizados por todas las operaciones.
30-
</para>
27+
<simpara>
28+
Devuelve el número total de documentos insertados o actualizados (upserted) por todas las operaciones.
29+
</simpara>
3130
</refsect1>
3231

3332
<refsect1 role="errors">

‎reference/mongodb/mongodb/driver/bulkwritecommandresult/isacknowledged.xml‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- EN-Revision: 187032b3ea20fa28f1c9f29ba38d06820428f849 Maintainer: PhilDaiguille Status: ready -->
3-
<!-- Reviewed: yes -->
4-
2+
<!-- EN-Revision: 9f4cb232d01a06077a2324e38f767d63f87f2e5f Maintainer: PhilDaiguille Status: ready -->
3+
<!-- Reviewed: no -->
54
<refentry xml:id="mongodb-driver-bulkwritecommandresult.isacknowledged" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
65
<refnamediv>
76
<refname>MongoDB\Driver\BulkWriteCommandResult::isAcknowledged</refname>
8-
<refpurpose>Indica si la escritura fue reconocida</refpurpose>
7+
<refpurpose>Devuelve si la escritura fue reconocida</refpurpose>
98
</refnamediv>
109

1110
<refsect1 role="description">
@@ -14,9 +13,10 @@
1413
<modifier>final</modifier> <modifier>public</modifier> <type>bool</type><methodname>MongoDB\Driver\BulkWriteCommandResult::isAcknowledged</methodname>
1514
<void />
1615
</methodsynopsis>
17-
<para>
18-
Si la escritura fue reconocida, los demás campos estarán disponibles en el objeto <classname>MongoDB\Driver\BulkWriteCommandResult</classname>.
19-
</para>
16+
<simpara>
17+
Si la escritura es reconocida, otros campos estarán disponibles en el
18+
objeto <classname>MongoDB\Driver\BulkWriteCommandResult</classname>.
19+
</simpara>
2020
</refsect1>
2121

2222
<refsect1 role="parameters">
@@ -26,9 +26,9 @@
2626

2727
<refsect1 role="returnvalues">
2828
&reftitle.returnvalues;
29-
<para>
29+
<simpara>
3030
Devuelve &true; si la escritura fue reconocida, y &false; en caso contrario.
31-
</para>
31+
</simpara>
3232
</refsect1>
3333

3434
<refsect1 role="errors">
@@ -41,7 +41,7 @@
4141
<refsect1 role="examples">
4242
&reftitle.examples;
4343
<example>
44-
<title><function>MongoDB\Driver\BulkWriteCommandResult::isAcknowledged</function> con escritura reconocida</title>
44+
<title><function>MongoDB\Driver\BulkWriteCommandResult::isAcknowledged</function> con preocupación de escritura reconocida</title>
4545
<programlisting role="php">
4646
<![CDATA[
4747
<?php
@@ -66,7 +66,7 @@ bool(true)
6666
</screen>
6767
</example>
6868
<example>
69-
<title><function>MongoDB\Driver\BulkWriteCommandResult::isAcknowledged</function> con escritura no reconocida</title>
69+
<title><function>MongoDB\Driver\BulkWriteCommandResult::isAcknowledged</function> con preocupación de escritura no reconocida</title>
7070
<programlisting role="php">
7171
<![CDATA[
7272
<?php
@@ -98,7 +98,7 @@ bool(false)
9898
&reftitle.seealso;
9999
<simplelist>
100100
<member><classname>MongoDB\Driver\WriteConcern</classname></member>
101-
<member><link xlink:href="&url.mongodb.docs.writeconcern;">Referencia de Write Concern</link></member>
101+
<member><link xlink:href="&url.mongodb.docs.writeconcern;">Referencia de preocupación de escritura</link></member>
102102
</simplelist>
103103
</refsect1>
104104

0 commit comments

Comments
 (0)