mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
Doc/reference/lexical_analysis.rst
View File

@ -696,6 +696,17 @@ a temporary variable.
>>> f"newline: {newline}" >>> f"newline: {newline}"
'newline: 10' '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, See also :pep:`498` for the proposal that added formatted string literals,
and :meth:`str.format`, which uses a related format string mechanism. and :meth:`str.format`, which uses a related format string mechanism.