Apply suggestions from code review

Co-authored-by: C.A.M. Gerlach <[email protected]>

Author: hugovk

.github/workflows/doc.yml

@@ -57,20 +57,21 @@ jobs:
     - name: Get list of changed files
       id: changed_files
       uses: Ana06/[email protected]
-    - name: 'Build changed files with nitpicks'
+    - name: 'Build changed files in nit-picky mode'
       continue-on-error: true
       run: |
         # Mark files the pull request modified
         touch ${{ steps.changed_files.outputs.added_modified }}
-        # Build docs with the '-n' (nit-picky) option, convert warnings
+        # Build docs with the '-n' (nit-picky) option; convert warnings to annotations
         make -C Doc/ PYTHON=../python SPHINXOPTS="-q -n --keep-going" html 2>&1 |
             python Doc/tools/warnings-to-gh-actions.py
 
-    # Ensure some files always pass Sphinx nitpicks (missing references)
-    - name: 'Build others with nitpicks'
+    # Ensure some files always pass Sphinx nit-picky mode (no missing references)
+    - name: 'Build known-good files in nit-picky mode'
       run: |
         # Mark files that must pass nit-picky
         touch Doc/whatsnew/3.12.rst
+        touch Doc/library/sqlite3.rst
         # Build docs with the '-n' (nit-picky) option, convert warnings to errors (-W)
         make -C Doc/ PYTHON=../python SPHINXOPTS="-q -n -W --keep-going" html 2>&1
 

Doc/tools/warnings-to-gh-actions.py

@@ -1,6 +1,7 @@
 #!/usr/bin/env python3
 
-"""Convert Sphinx warning messages to GitHub Actions
+"""
+Convert Sphinx warning messages to GitHub Actions.
 
 Converts lines like:
     .../Doc/library/cgi.rst:98: WARNING: reference target not found
@@ -12,8 +13,8 @@
 see: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-a-warning-message
 """
 
-import sys
 import re
+import sys
 
 pattern = re.compile(r'(?P<file>[^:]+):(?P<line>\d+): WARNING: (?P<msg>.+)')
 

Doc/whatsnew/3.12.rst

@@ -1003,7 +1003,7 @@ Deprecated
   :c:type:`PyConfig` instead.
   (Contributed by Victor Stinner in :gh:`77782`.)
 
-* Creating :const:`immutable types <Py_TPFLAGS_IMMUTABLETYPE>` with mutable
+* Creating immutable types (:const:`Py_TPFLAGS_IMMUTABLETYPE`) with mutable
   bases is deprecated and will be disabled in Python 3.14.
 
 * The ``structmember.h`` header is deprecated, though it continues to be