Skip to content

Windows Launcher docs use incorrect version in examples #101294

@cringti

Description

@cringti

Documentation

The "Python Launcher for Windows" section, specifically the "Getting Started" "From a Script" section, uses hard-coded versions when describing shebang behavior, but uses the macro-defined "version" when describing the output. The specific source file with the issue is Doc/using/windows.rst.

As a result, the generated docs say confusing things like "Assuming you have Python 3.7 installed, try changing the first line to #! python3.7 and you should find the Python 3.11 version information printed."

In this case, python "3.7" is hard-coded in the .rst source (which is fine), but "3.11" is generated from a macro, and will therefore vary from release to release.

The docs should either always use the version macro for examples like this, or never use it.

Note that this is just one case I stumbled on. Casually reviewing similar "version" macro usage finds related issues, so a general review for usage of the "version" macro would be useful.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dir

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions