runpy: use docstrings for all helpers
#135507
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
All commit authors signed the Contributor License Agreement. |
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
runpy.py defines four helpers, and two are not documented using docstrings.
With this change, docstrings are used on all helpers:
> $ sed -ne '/def /h; /Helper/{x;G;p}' Lib/runpy.py
>
> def _run_code(code, run_globals, init_globals=None,
> """Helper to run code in nominated namespace"""
> def _run_module_code(code, init_globals=None,
> """Helper to run code in new namespace with sys modified"""
> def _get_module_details(mod_name, error=ImportError):
> """Helper to get the full name, spec and code for a module"""
> def _get_main_module_details(error=ImportError):
> """Helper that gives a nicer error message when attempting to
Signed-off-by: Ariel Otilibili <[email protected]>
ariel-anieli
force-pushed
the
runpy-docstrings-helpers
branch
from
c9f6ccd to
2635aa5
Compare
|
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
|
Thanks, but I don't think we need this change for private (non-user-facing) callables. A |
|
I see, @AA-Turner; thanks for the feedback. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello maintainers,
Thanks for keeping Python alive; I have been using it for years, and this is my first ever contribution.
runpy.pydefines four helpers, and two are not documented using docstrings.With this change, docstrings are used on all helpers:
Your feedback is much appreciated,