Skip to content

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

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.

Sign up for GitHub

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
serhiy-storchaka merged 2 commits into from
Feb 19, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea070a2
Remove :platform:s
StanFromIreland Feb 19, 2026
818e8dd
Add missing `.. availability::`s
StanFromIreland Feb 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Doc/library/curses.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
.. module:: curses
:synopsis: An interface to the curses library, providing portable
terminal handling.
:platform: Unix

.. sectionauthor:: Moshe Zadka <moshez@zadka.site.co.il>
.. sectionauthor:: Eric Raymond <esr@thyrsus.com>
Expand All @@ -25,6 +24,8 @@ Linux and the BSD variants of Unix.

.. 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.


.. note::

Whenever the documentation mentions a *character* it can be specified
Expand Down
7 changes: 4 additions & 3 deletions Doc/library/dbm.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,6 @@ The individual submodules are described in the following sections.
----------------------------------------------

.. module:: dbm.sqlite3
:platform: All
:synopsis: SQLite backend for dbm

.. versionadded:: 3.13
Expand Down Expand Up @@ -224,7 +223,6 @@ or any other SQLite browser, including the SQLite CLI.
----------------------------------------

.. module:: dbm.gnu
:platform: Unix
:synopsis: GNU database manager

**Source code:** :source:`Lib/dbm/gnu.py`
Expand All @@ -242,6 +240,8 @@ functionality like crash tolerance.

.. include:: ../includes/wasm-mobile-notavail.rst

.. availability:: Unix.

.. exception:: error

Raised on :mod:`!dbm.gnu`-specific errors, such as I/O errors. :exc:`KeyError` is
Expand Down Expand Up @@ -347,7 +347,6 @@ functionality like crash tolerance.
-----------------------------------------

.. module:: dbm.ndbm
:platform: Unix
:synopsis: The New Database Manager

**Source code:** :source:`Lib/dbm/ndbm.py`
Expand All @@ -373,6 +372,8 @@ This module can be used with the "classic" NDBM interface or the

.. include:: ../includes/wasm-mobile-notavail.rst

.. availability:: Unix.

.. exception:: error

Raised on :mod:`!dbm.ndbm`-specific errors, such as I/O errors. :exc:`KeyError` is raised
Expand Down
3 changes: 0 additions & 3 deletions Doc/library/dialog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Tkinter Dialogs
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. module:: tkinter.simpledialog
:platform: Tk
:synopsis: Simple dialog windows

**Source code:** :source:`Lib/tkinter/simpledialog.py`
Expand Down Expand Up @@ -43,7 +42,6 @@ functions for creating simple modal dialogs to get a value from the user.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. module:: tkinter.filedialog
:platform: Tk
:synopsis: Dialog classes for file selection

**Source code:** :source:`Lib/tkinter/filedialog.py`
Expand Down Expand Up @@ -208,7 +206,6 @@ These do not emulate the native look-and-feel of the platform.
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. module:: tkinter.commondialog
:platform: Tk
:synopsis: Tkinter base class for dialogs

**Source code:** :source:`Lib/tkinter/commondialog.py`
Expand Down
1 change: 0 additions & 1 deletion Doc/library/fcntl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
==========================================================

.. module:: fcntl
:platform: Unix
:synopsis: The fcntl() and ioctl() system calls.

.. sectionauthor:: Jaap Vermeulen
Expand Down
1 change: 0 additions & 1 deletion Doc/library/grp.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
==================================

.. module:: grp
:platform: Unix
:synopsis: The group database (getgrnam() and friends).

--------------
Expand Down
1 change: 0 additions & 1 deletion Doc/library/msvcrt.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
===========================================================

.. module:: msvcrt
:platform: Windows
:synopsis: Miscellaneous useful routines from the MS VC++ runtime.

.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
Expand Down
1 change: 0 additions & 1 deletion Doc/library/posix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
====================================================

.. module:: posix
:platform: Unix
:synopsis: The most common POSIX system calls (normally used via module os).

--------------
Expand Down
1 change: 0 additions & 1 deletion Doc/library/pty.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
=========================================

.. module:: pty
:platform: Unix
:synopsis: Pseudo-Terminal Handling for Unix.

.. moduleauthor:: Steen Lumholt
Expand Down
1 change: 0 additions & 1 deletion Doc/library/pwd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
=====================================

.. module:: pwd
:platform: Unix
:synopsis: The password database (getpwnam() and friends).

--------------
Expand Down
3 changes: 2 additions & 1 deletion Doc/library/readline.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
===========================================

.. module:: readline
:platform: Unix
:synopsis: GNU readline support for Python.

.. sectionauthor:: Skip Montanaro <skip.montanaro@gmail.com>
Expand All @@ -28,6 +27,8 @@ Readline library in general.

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

.. availability:: Unix.

.. note::

The underlying Readline library API may be implemented by
Expand Down
1 change: 0 additions & 1 deletion Doc/library/resource.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
===============================================

.. module:: resource
:platform: Unix
:synopsis: An interface to provide resource usage information on the current process.

.. moduleauthor:: Jeremy Hylton <jeremy@alum.mit.edu>
Expand Down
1 change: 0 additions & 1 deletion Doc/library/syslog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
===============================================

.. module:: syslog
:platform: Unix
:synopsis: An interface to the Unix syslog library routines.

--------------
Expand Down
1 change: 0 additions & 1 deletion Doc/library/termios.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
===========================================

.. module:: termios
:platform: Unix
:synopsis: POSIX style tty control.

.. index::
Expand Down
1 change: 0 additions & 1 deletion Doc/library/tkinter.colorchooser.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
======================================================

.. module:: tkinter.colorchooser
:platform: Tk
:synopsis: Color choosing dialog

**Source code:** :source:`Lib/tkinter/colorchooser.py`
Expand Down
1 change: 0 additions & 1 deletion Doc/library/tkinter.dnd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
=============================================

.. module:: tkinter.dnd
:platform: Tk
:synopsis: Tkinter drag-and-drop interface

**Source code:** :source:`Lib/tkinter/dnd.py`
Expand Down
1 change: 0 additions & 1 deletion Doc/library/tkinter.font.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
=============================================

.. module:: tkinter.font
:platform: Tk
:synopsis: Tkinter font-wrapping class

**Source code:** :source:`Lib/tkinter/font.py`
Expand Down
1 change: 0 additions & 1 deletion Doc/library/tkinter.messagebox.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
======================================================

.. module:: tkinter.messagebox
:platform: Tk
:synopsis: Various types of alert dialogs

**Source code:** :source:`Lib/tkinter/messagebox.py`
Expand Down
1 change: 0 additions & 1 deletion Doc/library/tkinter.scrolledtext.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
=====================================================

.. module:: tkinter.scrolledtext
:platform: Tk
:synopsis: Text widget with a vertical scroll bar.

.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
Expand Down
1 change: 0 additions & 1 deletion Doc/library/tty.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
==========================================

.. module:: tty
:platform: Unix
:synopsis: Utility functions that perform common terminal control operations.

.. moduleauthor:: Steen Lumholt
Expand Down
1 change: 0 additions & 1 deletion Doc/library/winreg.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
==========================================

.. module:: winreg
:platform: Windows
:synopsis: Routines and objects for manipulating the Windows registry.

.. sectionauthor:: Mark Hammond <MarkH@ActiveState.com>
Expand Down
1 change: 0 additions & 1 deletion Doc/library/winsound.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
========================================================

.. module:: winsound
:platform: Windows
:synopsis: Access to the sound-playing machinery for Windows.

.. moduleauthor:: Toby Dickenson <htrd90@zepler.org>
Expand Down
Loading