gh-143299: Doc: Clarify inspect.getsource behavior regarding shared lines #143301
Conversation
|
All commit authors signed the Contributor License Agreement. |
| @@ -0,0 +1 @@ | |||
| Doc: Clarify inspect.getsource behavior regarding shared lines (GH-143299) | |||
There was a problem hiding this comment.
If we only update docs, we don't needs a NEWS entry usually. Also, we don't mention the GH issue either (I'd suggest having a look at the contents of Misc/NEWS.d/next to see how other NEWS entries are formatted)
a12k
force-pushed
the
doc-fix-inspect-getsource
branch
from
af494f9 to
177a040
Compare
| A :exc:`TypeError` is raised if the object is a built-in module, class, or | ||
| function. | ||
|
|
||
| .. note:: |
There was a problem hiding this comment.
note is too loгd. This can be an ordinary paragraph. AFAIK classes and normal funtions always take the whole line, so this not is only related to lambdas and generator expressions (generator expressions themselves are not supported, but code, frames and tracebacks do). It would be better to mention them explicitly, so the user that searches the sources of a class or normal function should not worry.
This should be repeated for getsourcelines().
3 participants
Fixing the ambiguity where getsource returns full lines for lambdas/comprehensions.
Closes gh-143299
📚 Documentation preview 📚: https://cpython-previews--143301.org.readthedocs.build/