Clarify docs for functions taking bytes and not str.

dlrd · May 24, 2018 · 55dc131 · 55dc131
1 parent e763f04
commit 55dc131
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -27,6 +27,7 @@ MANIFEST
 *.py[co]
 *.egg-info
 *~
+.*.swp
 .DS_Store
 /dist
 /build

diff --git a/docs/advanced/cast/strings.rst b/docs/advanced/cast/strings.rst
@@ -58,7 +58,9 @@ Passing bytes to C++
 --------------------
 
 A Python ``bytes`` object will be passed to C++ functions that accept
-``std::string`` or ``char*`` *without* conversion.
+``std::string`` or ``char*`` *without* conversion.  On Python 3, in order to
+make a function *only* accept ``bytes`` (and not ``str``), declare it as taking
+a ``py::bytes`` argument.
 
 
 Returning C++ strings to Python
-Original file line number
+Diff line change
@@ Expand Up / @@ -27,6 +27,7 @@ MANIFEST @@
     *.py[co]
     *.egg-info
     *~
+    .*.swp
     .DS_Store
     /dist
     /build
@@ Expand Down @@