GeezerVisonThe World Wide Web, restored to 800 pixels of glory. | ||||||||
| Home|About|Gaming cabinet|Archives|How it works|Starter sites | ||||||||
GeezerVison is showing github.com — gh-115937: Remove implementation details from inspect.signature() docs by erlend-aasland · Pull Request #116086 · python/cpython Conversation
|
|
I disapprove of this way of solving the issue. @ethanfurman did not explain the rationale for changing the inspect module this way for the sole benefit of enum where it would have been just as easy not to (as #115984 shows). The use of |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
I'd leave the "Consult the source code for current semantics." bit off as that feels implied to be when calling something "an implementation detail". But no big deal either way as it is true.
I do understand the Python user desire for officially describing and documenting __signature__ behavior as a public API people can rely on. That's outside the scope of this specific issue as this doc update is just trying to set expectations anywhere the existing implementation detail is mentioned.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
@erlend-aasland I think this documentation change with the implementation detail directive accurately reflects the current status of the underlying source code.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
@Gouvernathor As @gpshead mentions, I think having a separate (from documentation) discussion about behavior as a public API makes good sense. Also, I see you maintain ren'py, thanks for doing so. For years, my daughter used it to create interactive game scenarios (she is now a game developer). |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
Should I close #115984 in favor of this approach? |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
Yes, please. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
Thanks for the reviews! |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
…() docs (pythonGH-116086) (cherry picked from commit fb2e17b) Co-authored-by: Erlend E. Aasland <[email protected]> Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Gregory P. Smith <[email protected]> Co-authored-by: Jelle Zijlstra <[email protected]>
…() docs (pythonGH-116086) (cherry picked from commit fb2e17b) Co-authored-by: Erlend E. Aasland <[email protected]> Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Gregory P. Smith <[email protected]> Co-authored-by: Jelle Zijlstra <[email protected]>
|
GH-116106 is a backport of this pull request to the 3.12 branch. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
|
GH-116107 is a backport of this pull request to the 3.11 branch. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
…e() docs (GH-116086) (#116106) gh-115937: Remove implementation details from inspect.signature() docs (GH-116086) (cherry picked from commit fb2e17b) Co-authored-by: Erlend E. Aasland <[email protected]> Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Gregory P. Smith <[email protected]> Co-authored-by: Jelle Zijlstra <[email protected]>
…e() docs (GH-116086) (#116107) gh-115937: Remove implementation details from inspect.signature() docs (GH-116086) (cherry picked from commit fb2e17b) Co-authored-by: Erlend E. Aasland <[email protected]> Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Gregory P. Smith <[email protected]> Co-authored-by: Jelle Zijlstra <[email protected]>
Following this, I think I will open a non-doc issue about reverting what #100039 changed about signatures. But aside from that, and contrary to my first impression, that Enum PR didn't actually introduce an incompatible change. The
You're very welcome. All the best to your daughter. |
Sorry, something went wrong.
There was an error while loading. Please reload this page.
…() docs (python#116086) Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Gregory P. Smith <[email protected]> Co-authored-by: Jelle Zijlstra <[email protected]>
…() docs (python#116086) Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Gregory P. Smith <[email protected]> Co-authored-by: Jelle Zijlstra <[email protected]>
…() docs (python#116086) Co-authored-by: Carol Willing <[email protected]> Co-authored-by: Gregory P. Smith <[email protected]> Co-authored-by: Jelle Zijlstra <[email protected]>
There was an error while loading. Please reload this page.
Successfully merging this pull request may close these issues.
Incorrect description of the __signature__ attribute in docs
There was an error while loading. Please reload this page.