Skip to content

gh-131170: fix duplicated sections in frames.md file #131177

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

Merged
merged 1 commit into from
Mar 13, 2025

Conversation

nybblista
Copy link
Contributor

@nybblista nybblista commented Mar 13, 2025

In the "frames.md" file at InternalDocs, I have changed the first duplicated title to Specials and removed the unnecessary content under the Specials section.

In the frames.md file at InternalDocs, change the first
duplicated title to Specials, and remove unnecessary content
under the Specials section.
@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Mar 13, 2025
@ghost
Copy link

ghost commented Mar 13, 2025

All commit authors signed the Contributor License Agreement.
CLA signed

Copy link

@auvipy auvipy left a comment

Choose a reason for hiding this comment

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

looks good to me.

@@ -0,0 +1,2 @@
The duplication of titles in the frames.md file at InternalDocs has been
Copy link
Member

Choose a reason for hiding this comment

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

No need for a NEWS entry as it's internal documentation and not exposed documentation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you. However, it would be a good idea to add this comment as a note in the devguide, specifically in the quick reference at step 8. 👍🏻

https://devguide.python.org/#quick-reference

Copy link
Member

Choose a reason for hiding this comment

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

Do you mean, the fact that it's an internal-only?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes

Copy link
Member

Choose a reason for hiding this comment

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

I guess it doesn't hurt to specify when a NEWS entry is really needed. Thanks for the feedback!

Copy link
Member

@sobolevn sobolevn 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!

@sobolevn sobolevn merged commit e9d210b into python:main Mar 13, 2025
54 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Mar 13, 2025
@picnixz
Copy link
Member

picnixz commented Mar 13, 2025

I was planning to merge it after eating something but you beat me to it!

@nybblista nybblista deleted the fix-issue-131170 branch March 13, 2025 14:08
@sobolevn
Copy link
Member

In fact, I was eating while merging 🥘

plashchynski pushed a commit to plashchynski/cpython that referenced this pull request Mar 17, 2025
…1177)

fix duplicated sections in frames.md file

In the frames.md file at InternalDocs, change the first
duplicated title to Specials, and remove unnecessary content
under the Specials section.
seehwan pushed a commit to seehwan/cpython that referenced this pull request Apr 16, 2025
…1177)

fix duplicated sections in frames.md file

In the frames.md file at InternalDocs, change the first
duplicated title to Specials, and remove unnecessary content
under the Specials section.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants