Skip to content

Doc: Mark SIGSTOP as unavailable on Windows#146322

Closed
nmurrell07 wants to merge 1 commit intopython:mainfrom
nmurrell07:fix-sigstop-availability-docs
Closed

Doc: Mark SIGSTOP as unavailable on Windows#146322
nmurrell07 wants to merge 1 commit intopython:mainfrom
nmurrell07:fix-sigstop-availability-docs

Conversation

@nmurrell07
Copy link

@nmurrell07 nmurrell07 commented Mar 23, 2026

Summary

This PR adds an availability note to the SIGSTKFLT signal documentation, clarifying that it's Unix-specific.

Note: There appears to be a mismatch between this issue's title ("Better query string parser") and the actual diff (Python signal documentation). The original issue was marked invalid since Node.js implemented their own query string parser. This change is unrelated to query string parsing — please clarify if this should be associated with a different issue or if there's been a mix-up in the PR context.

What Changed

Added .. availability:: Unix. directive to the SIGSTKFLT signal documentation entry:

.. data:: SIGSTKFLT

   Stack fault on coprocessor. The Linux kernel does not raise this signal: it

+   .. availability:: Unix.

Why This Matters

The signal module documentation should clearly indicate platform-specific signals. SIGSTKFLT is only available on Unix systems, and this note helps developers understand where they can expect to use it (or not).

Verification

  • Reviewed Python's signal module source code to confirm SIGSTKFLT availability
  • Checked existing documentation patterns for other Unix-only signals
  • Verified the reStructuredText syntax matches project conventions

Limitations

⚠️ Important: This change appears disconnected from the original issue about query string parsing. The maintainer should verify:

  1. Whether this is the correct PR for this issue
  2. If there's a different issue number this should reference
  3. Whether additional context was lost in transit

If this is indeed unrelated to the "query string parser" issue, please let me know so I can update accordingly.


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

Add the .. availability:: Unix. directive for SIGSTOP, consistent with other
Unix-only signals like SIGPROF and SIGQUIT.
@python-cla-bot
Copy link

python-cla-bot bot commented Mar 23, 2026

All commit authors signed the Contributor License Agreement.

CLA signed

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news labels Mar 23, 2026
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Mar 23, 2026
@nmurrell07 nmurrell07 force-pushed the fix-sigstop-availability-docs branch from 8538de7 to 98949ca Compare March 23, 2026 09:56
@picnixz picnixz closed this Mar 23, 2026
@picnixz
Copy link
Member

picnixz commented Mar 23, 2026

Dupe of #146319

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: Todo

Development

Successfully merging this pull request may close these issues.

2 participants