[New-bugs-announce] [issue35887] Doc string for updating the frozen version of importlib in _bootstrap.py incorrect

[Nina Zakharenko]

New submission from Nina Zakharenko <nzakharenko at gmail.com>:

In the process of creating a fix for issue #35321, I noticed what I believe to be a documentation omission. 

In Lib/importlib/_bootstrap.py the top level comment states that:

# IMPORTANT: Whenever making changes to this module, be sure to run
# a top-level make in order to get the frozen version of the module
# updated.

>From my testing, it appears that the header file will only be updated when running `make regen-importlib`

To repo:
- make a code change in Lib/importlib/_bootstrap_external.py
- run a top-level `make`
- see that Python/importlib.h does not change
- run `make regen-importlib`
- see that Python/importlib.h has now been updated

The documentation in Lib/importlib/_bootstrap_external.py does in fact mention this.

I propose amending the documentation to include the correct instructions.

If this is deemed necessary, I will write the patch over the weekend.

----------
assignee: nnja
components: Library (Lib)
messages: 334735
nosy: barry, nnja
priority: low
severity: normal
status: open
title: Doc string for updating the frozen version of importlib in _bootstrap.py incorrect
versions: Python 3.8

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue35887>
_______________________________________