Skip to content

Improve clarity and formatting in help-documenting.rst#1746

Open
Parth-Nakti wants to merge 2 commits intopython:mainfrom
Parth-Nakti:improve-help-documenting-clarity
Open

Improve clarity and formatting in help-documenting.rst#1746
Parth-Nakti wants to merge 2 commits intopython:mainfrom
Parth-Nakti:improve-help-documenting-clarity

Conversation

@Parth-Nakti
Copy link

This PR improves wording clarity and formatting in help-documenting.rst.

Changes include:

  • Improved sentence flow in the introduction
  • Proper bullet formatting
  • Minor wording improvements for readability

@python-cla-bot
Copy link

python-cla-bot bot commented Feb 28, 2026

All commit authors signed the Contributor License Agreement.

CLA signed

@read-the-docs-community
Copy link

Documentation build overview

📚 CPython devguide | 🛠️ Build #31598350 | 📁 Comparing 1d9d867 against latest (16c670e)


🔍 Preview build

Show files changed (2 files in total): 📝 2 modified | ➕ 0 added | ➖ 0 deleted
File Status
versions/index.html 📝 modified
documentation/help-documenting/index.html 📝 modified

@hugovk
Copy link
Member

hugovk commented Feb 28, 2026

Was this generated by an LLM?

I prefer the human touch in the original.

@StanFromIreland
Copy link
Member

I agree, I see this as a negative change, it also removes many helpful links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants