Skip to content

Document signal.* signals to fix Sphinx references #139843

@LamentXU123

Description

@LamentXU123

in https://docs.python.org/3/library/signal.html we've got a document for every signal const like signal.SIGALRM, all supported signals are basically listed here
(except for user-defined signals and some other signals elsewhere)
Image

however, there is no document for SIGQUIT, with every other const documented. This directly cause to a reference warning in sphinx build:

C:\Users\admin\Desktop\cpython-main\Doc\library\signal.rst:116: WARNING: py:const reference target not found: SIGQUIT [ref.const]

I'm now working on fixing the warning of this document, and I think we need a doc for SIGQUIT. Something like:

.. data:: SIGQUIT 

   Proccess quit.

   .. availability:: Unix.

Linked PRs

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dir

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions