[gi-docgen/ebassi/transfer-docs: 1/2] generate: Use clearer wording for the transfer rules
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gi-docgen/ebassi/transfer-docs: 1/2] generate: Use clearer wording for the transfer rules
- Date: Fri, 9 Apr 2021 18:18:03 +0000 (UTC)
commit c7faf978f2387dff4ae8e3d66095956e5d7779c9
Author: Emmanuele Bassi <ebassi gnome org>
Date: Fri Apr 9 18:52:42 2021 +0100
generate: Use clearer wording for the transfer rules
gidocgen/gdgenerate.py | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
---
diff --git a/gidocgen/gdgenerate.py b/gidocgen/gdgenerate.py
index d432209..1ac1d65 100644
--- a/gidocgen/gdgenerate.py
+++ b/gidocgen/gdgenerate.py
@@ -27,16 +27,16 @@ STRING_TYPES = {
}
ARG_TRANSFER_MODES = {
- 'none': 'Ownership is not transferred to the callee',
- 'container': 'Ownership of the container type is transferred to the callee',
- 'full': 'Ownership of the data is transferred to the callee',
+ 'none': 'The data is owned by the caller of the function',
+ 'container': 'The called function takes ownership of the data container, but not the data inside it',
+ 'full': 'The called function takes ownership of the data, and is responsible for freeing it',
}
RETVAL_TRANSFER_MODES = {
- 'none': 'Ownership is not transferred to the caller',
- 'container': 'Ownership of the container type is transferred to the caller',
- 'full': 'Ownership of the data is transferred to the caller',
- 'floating': 'The returned object has a floating reference',
+ 'none': 'The data is owned by the called function',
+ 'container': 'The caller of the function takes ownership of the data container, but not the data inside
it',
+ 'full': 'The caller of the function takes ownership of the data, and is responsible for freeing it',
+ 'floating': 'The returned data has a floating reference',
}
DIRECTION_MODES = {
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]