Skip to content
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.

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

gh-128039: Clarify the uninstallation instructions for Mac. #128040

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

offby1
Copy link

@offby1 offby1 commented Dec 17, 2024

I've applied the wording that I suggested in #128039 .


📚 Documentation preview 📚: https://cpython-previews--128040.org.readthedocs.build/

Doc/using/mac.rst Outdated Show resolved Hide resolved
Doc/using/mac.rst Outdated Show resolved Hide resolved
Copy link
Member

@ned-deily ned-deily left a comment

Choose a reason for hiding this comment

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

Thank you for the PR! My only suggestion is to include the free-threaded option in the list.

Doc/using/mac.rst Show resolved Hide resolved
Doc/using/mac.rst Outdated Show resolved Hide resolved
@bedevere-app
Copy link

bedevere-app bot commented Dec 17, 2024

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

* Also within the |usemac_applications_folder_name| folder: :program:`Python Launcher`, which handles double-clicking
Python scripts from the macOS `Finder <https://support.apple.com/en-us/HT201732>`_;

* A :file:`3.13` folder (under the "framework" :file:`/Library/Frameworks/Python.framework`), which includes the
Copy link
Member

Choose a reason for hiding this comment

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

Rather than hardcoding 3.13 which is only correct for a single branch, let's use a "replacement":

Suggested change
* A :file:`3.13` folder (under the "framework" :file:`/Library/Frameworks/Python.framework`), which includes the
* A |usemac_x_dot_y_literal| folder (under the "framework" :file:`/Library/Frameworks/Python.framework`), which includes the

And add it with the others in this file:

 .. |usemac_x_dot_y| replace:: 3.13
+.. |usemac_x_dot_y_literal| replace:: ``3.13``
 .. |usemac_python_x_dot_y_literal| replace:: ``python3.13``
 .. |usemac_python_x_dot_y_t_literal| replace:: ``python3.13t``
 .. |usemac_python_x_dot_y_t_literal_config| replace:: ``python3.13t-config``

And actually, those are still hardcoded, so let's remove the usemac_ prefix and integrate them into the rst_epilog which uses the current version number:

cpython/Doc/conf.py

Lines 77 to 80 in be8ae08

rst_epilog = f"""
.. |python_version_literal| replace:: ``Python {version}``
.. |python_x_dot_y_literal| replace:: ``python{version}``
.. |usr_local_bin_python_x_dot_y_literal| replace:: ``/usr/local/bin/python{version}``

The rst_epilog replacements are available for all pages.

Copy link
Author

@offby1 offby1 Dec 17, 2024

Choose a reason for hiding this comment

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

This is surely The Right Thing®, but I'm unfamiliar enough with ReStructured Text to do it myself (I took a stab at it and found myself going in circles after an hour).

Copy link
Member

Choose a reason for hiding this comment

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

That's fine, we can do it in a followup. Thank you for trying!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting changes docs Documentation in the Doc dir skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

4 participants