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

Improved documentation: Updated clarity in 'Using the Python Interpreter' section #129235

Closed
wants to merge 2 commits into from

Conversation

Tripathi-Manjul
Copy link

@Tripathi-Manjul Tripathi-Manjul commented Jan 23, 2025

This pull request improves the clarity and readability of the 'Using the Python Interpreter' section in the tutorial.

Changes include:

  • Rephrased sentences for better readability.
  • Added clearer examples for command-line usage.
  • Improved explanations for interactive mode and environment variables.

No issue is associated with this PR as the changes are minor and focused solely on documentation enhancement.


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

Copy link

cpython-cla-bot bot commented Jan 23, 2025

All commit authors signed the Contributor License Agreement.
CLA signed

Copy link
Member

@picnixz picnixz left a comment

Choose a reason for hiding this comment

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

Please keep the changes separate. The change for fancy_termios is independent of the documentation change. In addition, RST markup is incorrect. Backticks are required.

Comment on lines +40 to +41
typing :kbd:`Control-P` to the first Python prompt you get. i.e. Pressing :kbd:Control-P
moves to the previous command in the command history. If it beeps, you
Copy link
Member

Choose a reason for hiding this comment

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

This change doesn't seem typographically correct and the markup is incorrect.

the :ref:`py.exe launcher <launcher>` installed, you can use the :file:`py`
command. See :ref:`setting-envvars` for other ways to launch Python.
On Windows, if you installed Python from the :ref:Microsoft Store <windows-store>,
the |python_x_dot_y_literal| command will be available. Alternatively, if you have the
Copy link
Member

@picnixz picnixz Jan 23, 2025

Choose a reason for hiding this comment

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

AFAIK, you might have both installed so it's not really "alternatively". Also, we should keep the mention about setting environment variables because it's relevant.

Comment on lines +43 to +45
# Always return a copy of the control characters list to ensure
# there are not any additional references to self.cc
self.cc[:],
Copy link
Member

Choose a reason for hiding this comment

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

This is an unrelated change.

@bedevere-app
Copy link

bedevere-app bot commented Jan 23, 2025

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.

@@ -11,8 +11,8 @@ Invoking the Interpreter
========================

The Python interpreter is usually installed as |usr_local_bin_python_x_dot_y_literal|
on those machines where it is available; putting :file:`/usr/local/bin` in your
Unix shell's search path makes it possible to start it by typing the command:
on those machines where it is available; Ensure /usr/local/bin is included in your Unix
Copy link
Contributor

Choose a reason for hiding this comment

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

Please keep lines under 80 chars as per PEP8.

@@ -0,0 +1 @@
Restore terminal control characters on REPL exit.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please also remove this along with the unrelated change.

@picnixz
Copy link
Member

picnixz commented Jan 24, 2025

Considering how the markup has been modified, I suspect this has been achieved using LLM and will close this one. Please read https://devguide.python.org/getting-started/pull-request-lifecycle/# and our policy on AI-generated content https://devguide.python.org/getting-started/generative-ai/.

@picnixz picnixz closed this Jan 24, 2025
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