Document escape_bytea properly

PyGreSQL · May 1, 2020 · 0874176 · 0874176
1 parent 5f70cda
commit 0874176
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 10 deletions.
diff --git a/docs/contents/changelog.rst b/docs/contents/changelog.rst
@@ -5,10 +5,10 @@ Version 5.2 (to be released)
 ----------------------------
 - We now require Python version 2.7 or 3.5 and newer
 - Changes to the classic PyGreSQL module (pg):
-  - New module level function `get_pqlib_version()` that gets the version
-    of the pqlib used by PyGreSQL (needs PostgreSQL >= 9.1 on the client).
-  - New query method `memsize()` that gets the memory size allocated by
-    the query (needs PostgreSQL >= 12 on the client).
+    - New module level function `get_pqlib_version()` that gets the version
+      of the pqlib used by PyGreSQL (needs PostgreSQL >= 9.1 on the client).
+    - New query method `memsize()` that gets the memory size allocated by
+      the query (needs PostgreSQL >= 12 on the client).
 
 
 Version 5.1.2 (2020-04-19)

diff --git a/docs/contents/pg/db_wrapper.rst b/docs/contents/pg/db_wrapper.rst
@@ -851,9 +851,9 @@ properties (such as character encoding).
 
     Escape binary data for use within SQL as type ``bytea``
 
-    :param str datastring: string containing the binary data that is to be escaped
+    :param bytes/str datastring: the binary data that is to be escaped
     :returns: the escaped string
-    :rtype: str
+    :rtype: bytes/str
 
 Similar to the module function :func:`pg.escape_bytea` with the same name,
 but the behavior of this method is adjusted depending on the connection
@@ -866,7 +866,7 @@ unescape_bytea -- unescape data retrieved from the database
 
     Unescape ``bytea`` data that has been retrieved as text
 
-    :param datastring: the ``bytea`` data string that has been retrieved as text
+    :param str string: the ``bytea`` string that has been retrieved as text
     :returns: byte string containing the binary data
     :rtype: bytes
 

diff --git a/docs/contents/pg/module.rst b/docs/contents/pg/module.rst
@@ -295,12 +295,13 @@ escape_bytea -- escape binary data for use within SQL
 
     escape binary data for use within SQL as type ``bytea``
 
-    :param str datastring: string containing the binary data that is to be escaped
+    :param bytes/str datastring: the binary data that is to be escaped
     :returns: the escaped string
-    :rtype: str
+    :rtype: bytes/str
     :raises TypeError: bad argument type, or too many arguments
 
 Escapes binary data for use within an SQL command with the type ``bytea``.
+The return value will have the same type as the given *datastring*.
 As with :func:`escape_string`, this is only used when inserting data directly
 into an SQL command string.
 
@@ -320,7 +321,7 @@ unescape_bytea -- unescape data that has been retrieved as text
 
     Unescape ``bytea`` data that has been retrieved as text
 
-    :param str datastring: the ``bytea`` data string that has been retrieved as text
+    :param str string: the ``bytea`` string that has been retrieved as text
     :returns: byte string containing the binary data
     :rtype: bytes
     :raises TypeError: bad argument type, or too many arguments