0
0
mirror of https://github.com/python/cpython.git synced 2024-12-01 11:15:56 +01:00

bpo-28739: Document that f-strings cannot be used as docstring (GH-592)

This commit is contained in:
Mariatta 2017-03-10 08:58:40 -08:00 committed by GitHub
parent 50da40fd52
commit d4e89287b3

View File

@ -696,6 +696,17 @@ a temporary variable.
>>> f"newline: {newline}"
'newline: 10'
Formatted string literals cannot be used as docstrings, even if they do not
include expressions.
::
>>> def foo():
... f"Not a docstring"
...
>>> foo.__doc__ is None
True
See also :pep:`498` for the proposal that added formatted string literals,
and :meth:`str.format`, which uses a related format string mechanism.