Skip to content

Remove unused :platform: in module's docs#144988

Merged
serhiy-storchaka merged 2 commits intopython:mainfrom
StanFromIreland:platform-doc
Feb 19, 2026
Merged

Remove unused :platform: in module's docs#144988
serhiy-storchaka merged 2 commits intopython:mainfrom
StanFromIreland:platform-doc

Conversation

@StanFromIreland
Copy link
Member

@StanFromIreland StanFromIreland commented Feb 19, 2026 •
edited by github-actions bot
Loading

It has not been outputted since Sphinx 1.1. And, furthermore, with our .. availability:: directive it is duplicated and unnecessary.

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

@bedevere-app bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Feb 19, 2026
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Feb 19, 2026
serhiy-storchaka
serhiy-storchaka reviewed Feb 19, 2026
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

Please ensure that there are corresponding availability directives in these cases. For example, I do not see availability in curses.rst.

@StanFromIreland
Copy link
Member Author

StanFromIreland commented Feb 19, 2026

curses.rst has the optional module notice: .. include:: ../includes/optional-module.rst

@StanFromIreland
Copy link
Member Author

StanFromIreland commented Feb 19, 2026

Most had them, I added a few missing ones.

serhiy-storchaka
serhiy-storchaka reviewed Feb 19, 2026
View reviewed changes
Doc/library/curses.rst

.. include:: ../includes/optional-module.rst

.. availability:: Unix.
Copy link
Member

@serhiy-storchaka serhiy-storchaka Feb 19, 2026

Choose a reason for hiding this comment

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

Remove period.

Copy link
Member Author

@StanFromIreland StanFromIreland Feb 19, 2026

Choose a reason for hiding this comment

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

The period is our standard? See https://github.com/search?q=repo%3Apython%2Fcpython+%22..+availability%3A%3A+Unix.%22&type=code or https://github.com/search?q=repo%3Apython%2Fcpython+%22..+availability%3A%3A+Windows.%22&type=code

Copy link
Member

@serhiy-storchaka serhiy-storchaka Feb 19, 2026

Choose a reason for hiding this comment

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

Hmm. The examples I came across were all without a period, but now I've looked up all the examples and most of them (353 of 428) have a period.

So this is fine.

Copy link
Member

@nedbat nedbat Feb 19, 2026

Choose a reason for hiding this comment

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

FWIW, the period looks odd to me too. It's not a sentence.

Copy link
Member

@serhiy-storchaka serhiy-storchaka Feb 19, 2026

Choose a reason for hiding this comment

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

5:1 in favor of period in existing examples. Whether we want to add period in the remaining examples, or remove them, this is a separate issue. There may even be prior discussions about this.

serhiy-storchaka
serhiy-storchaka approved these changes Feb 19, 2026
View reviewed changes
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

LGTM. 👍

Doc/library/curses.rst

.. include:: ../includes/optional-module.rst

.. availability:: Unix.
Copy link
Member

@serhiy-storchaka serhiy-storchaka Feb 19, 2026

Choose a reason for hiding this comment

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

Hmm. The examples I came across were all without a period, but now I've looked up all the examples and most of them (353 of 428) have a period.

So this is fine.

@serhiy-storchaka serhiy-storchaka merged commit 20caf1c into python:main Feb 19, 2026
33 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Feb 19, 2026
@serhiy-storchaka serhiy-storchaka added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Feb 19, 2026
@miss-islington-app
Copy link

miss-islington-app bot commented Feb 19, 2026

Thanks @StanFromIreland for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@miss-islington-app
Copy link

miss-islington-app bot commented Feb 19, 2026

Thanks @StanFromIreland for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

@miss-islington-app
Copy link

miss-islington-app bot commented Feb 19, 2026

Sorry, @StanFromIreland and @serhiy-storchaka, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 20caf1c08440684b618d2166022ae82b2db3b696 3.13

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 19, 2026
@StanFromIreland @miss-islington
Remove unused :platform: in module's docs (pythonGH-144988)
8dd3c75 
It has not been outputted since Sphinx 1.1.
(cherry picked from commit 20caf1c)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Feb 19, 2026

GH-144994 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Feb 19, 2026
serhiy-storchaka pushed a commit that referenced this pull request Feb 19, 2026
@miss-islington @StanFromIreland
[3.14] Remove unused :platform: in module's docs (GH-144988) (GH-144994)
24b5309 
Remove unused :platform: in module's docs (GH-144988)

It has not been outputted since Sphinx 1.1.
(cherry picked from commit 20caf1c)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
StanFromIreland added a commit to StanFromIreland/cpython that referenced this pull request Feb 19, 2026
@StanFromIreland
[3.13] Remove unused :platform: in module's docs (pythonGH-144988)
3aec48d 
It has not been outputted since Sphinx 1.1.
(cherry picked from commit 20caf1c)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Feb 19, 2026

GH-144998 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Feb 19, 2026
@StanFromIreland StanFromIreland deleted the platform-doc branch February 19, 2026 12:09
serhiy-storchaka pushed a commit that referenced this pull request Feb 19, 2026
@StanFromIreland
[3.13] Remove unused :platform: in module's docs (GH-144988) (GH-144998)
6294569 
It has not been outputted since Sphinx 1.1.
(cherry picked from commit 20caf1c)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nedbat nedbat nedbat left review comments

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

@corona10 corona10 Awaiting requested review from corona10 corona10 is a code owner

@erlend-aasland erlend-aasland Awaiting requested review from erlend-aasland erlend-aasland is a code owner

Assignees

@StanFromIreland StanFromIreland

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

Docs PRs
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@StanFromIreland @nedbat @serhiy-storchaka

Comments