Skip to content

Commit 5e9700f

Browse files
committed
Use consistent language in server description copy/destroy docs
1 parent a588d0b commit 5e9700f

File tree

2 files changed

+3
-4
lines changed

2 files changed

+3
-4
lines changed

src/libmongoc/doc/mongoc_server_description_destroy.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ Parameters
1919
Description
2020
-----------
2121

22-
Clean up all memory associated with the server description. Does nothing if ``description`` is NULL.
22+
Frees all resources associated with the server description. Does nothing if ``description`` is NULL.

src/libmongoc/doc/mongoc_server_description_new_copy.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,9 @@ Parameters
2020
Description
2121
-----------
2222

23-
This function copies the given server description and returns a new server description object. The caller is responsible for destroying the new copy.
23+
Performs a deep copy of ``description``.
2424

2525
Returns
2626
-------
2727

28-
A copy of the original server description.
29-
28+
Returns a newly allocated copy of ``description`` that should be freed with :symbol:`mongoc_server_description_destroy()` when no longer in use. Returns NULL if ``description`` is NULL.

0 commit comments

Comments
 (0)