Skip to content

gh-138952: Document platform.machine() output casing inconsistency across platforms #138962

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 17, 2025
Merged

gh-138952: Document platform.machine() output casing inconsistency across platforms #138962

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1b4a856
Add a note to the platform.machine() documentation section
Aniketsy Sep 16, 2025
08b07a2
Add a note to the platform.machine() documentation section
Aniketsy Sep 16, 2025
5d1679c
Update Doc/library/platform.rst
Aniketsy Sep 16, 2025
447ac2d
Doc: Simplify platform.machine() documentation and clarify output dif…
Aniketsy Sep 17, 2025
1263e14
Resolve merge conflicts in Doc/library/platform.rst
Aniketsy Sep 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions Doc/library/platform.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@ Cross platform
Returns the machine type, e.g. ``'AMD64'``. An empty string is returned if the
value cannot be determined.

.. note::

The output of :func:`platform.machine` is system-dependent and may differ
in casing and naming conventions across platforms. For example, on Apple
Silicon based macOS it may return ``'arm64'`` (lowercase), while on Windows-on-ARM
it may return ``'ARM64'`` (uppercase). If you need consistent results,
normalize the output in your code.
Copy link
Member

@StanFromIreland StanFromIreland Sep 16, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO, I think this whole section is a little excessive, I think just this would be fine:

.. function:: machine()

   Returns the machine type, e.g. ``'AMD64'``. An empty string is returned if the
   value cannot be determined.

   The output is platform-dependent and may differ in casing and naming
   conventions.

If we do want to stay with the note, please remove the link to the function, it is unnecessary.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should I update the changes as per your suggestions and remove the note section?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with @StanFromIreland's suggestion here. @Aniketsy, it would be nice if you could update the PR accordingly.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ned-deily I’ve updated the PR as suggested.



.. function:: node()

Expand Down
Loading