bpo-28739: Document that f-strings cannot be used as docstring (pytho…

…nGH-592)
evyroga · Mar 10, 2017 · d4e8928 · d4e8928
1 parent 50da40f
commit d4e8928
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/Doc/reference/lexical_analysis.rst b/Doc/reference/lexical_analysis.rst
@@ -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.