mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-30 20:31:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

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

Browse source 
(cherry picked from commit d4e89287b3)
This commit is contained in:
Mariatta 2017-03-10 09:52:03 -08:00 • committed by GitHub
parent faaa80fb98
commit ff6f371627
1 changed files with 11 additions and 0 deletions
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}"
'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.