Skip to content

Commit 934dd33

Browse files
committed
Update documentation for wtimeout_msec write concern params
1 parent 14a2705 commit 934dd33

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

doc/mongoc_write_concern_set_wmajority.page

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,14 @@ mongoc_write_concern_set_wmajority (mongoc_write_concern_t *write_concern,
2121
<title>Parameters</title>
2222
<table>
2323
<tr><td><p>write_concern</p></td><td><p>A <code xref="mongoc_write_concern_t">mongoc_write_concern_t</code>.</p></td></tr>
24-
<tr><td><p>wtimeout_msec</p></td><td><p>A int32_t.</p></td></tr>
24+
<tr><td><p>wtimeout_msec</p></td><td><p>A positive <code>int32_t</code> or zero.</p></td></tr>
2525
</table>
2626
</section>
2727

2828
<section id="description">
2929
<title>Description</title>
3030
<p>Sets if the write must have been propagated to a majority of nodes before indicating write success.</p>
31+
<p>The timeout specifies how long, in milliseconds, the server should wait before indicating that the write has failed. This is not the same as a socket timeout. A value of zero may be used to indicate no timeout.</p>
3132
</section>
3233

3334
</page>

doc/mongoc_write_concern_set_wtimeout.page

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,13 +22,13 @@ mongoc_write_concern_set_wtimeout (mongoc_write_concern_t *write_concern,
2222
<title>Parameters</title>
2323
<table>
2424
<tr><td><p>write_concern</p></td><td><p>A <code xref="mongoc_write_concern_t">mongoc_write_concern_t</code>.</p></td></tr>
25-
<tr><td><p>wtimeout_msec</p></td><td><p>A int32_t containing the timeout in milliseconds.</p></td></tr>
25+
<tr><td><p>wtimeout_msec</p></td><td><p>A positive <code>int32_t</code> or zero.</p></td></tr>
2626
</table>
2727
</section>
2828

2929
<section id="description">
3030
<title>Description</title>
31-
<p>Set the timeout in milliseconds that the server should wait before idicating that the write has failed. This is not the same as a socket timeout.</p>
31+
<p>Set the timeout in milliseconds that the server should wait before indicating that the write has failed. This is not the same as a socket timeout. A value of zero may be used to indicate no timeout.</p>
3232
</section>
3333

3434
</page>

0 commit comments

Comments
 (0)