Skip to content

Commit 4f81655

Browse files
committed
Change comment for the new return_as_bytes enum to note that the policy is not available on master.
1 parent 54a640c commit 4f81655

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

include/pybind11/detail/common.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -461,16 +461,16 @@ enum class return_value_policy : uint8_t {
461461
return_value_policy::reference and the keep_alive call policy */
462462
reference_internal,
463463

464-
/** This policy is experimental and likely to change in the future. With
465-
this policy, C++ string types are converted to Python bytes,
464+
/** With this policy, C++ string types are converted to Python bytes,
466465
instead of str. This is most useful when a C++ function returns a
467466
container-like type with nested C++ string types, and py::bytes cannot
468467
be applied easily. Dictionary like types might not work, for example,
469468
`Dict[str, bytes]`, because this policy forces all string return values
470469
to be converted to bytes. Note that this return_value_policy is not
471470
concerned with lifetime/ownership semantics, like the other policies,
472471
but the purpose of return_as_bytes is certain to be orthogonal, because
473-
C++ strings are always copied to Python bytes or str. */
472+
C++ strings are always copied to Python `bytes` or `str`.
473+
NOTE: This policy is NOT available on master. */
474474
return_as_bytes
475475
};
476476

0 commit comments

Comments
 (0)