Update: remove non-public stdlib docs

Co-Authored-By: Codex <codex@openai.com>

Author: heikkitoivonen

DOCUMENTATION_STATUS.md

@@ -4,9 +4,9 @@ This document tracks the coverage of built-in functions, types, and standard lib
 
 ## Overview
 
-- **Total Items**: 317 (150 builtins + 167 stdlib modules)
-- **Documented**: 389 (174 builtins + 215 stdlib)
-- **Coverage**: 122.7%
+- **Total Items**: 313 (150 builtins + 163 stdlib modules)
+- **Documented**: 385 (174 builtins + 211 stdlib)
+- **Coverage**: 123.0%
 
 **Note**: Coverage exceeds 100% because comprehensive documentation files (like `exceptions.md`) cover multiple individual items, and we document deprecated/removed modules for historical reference.
 
@@ -203,7 +203,7 @@ Complete coverage of all built-in functions, types, exceptions, and constants:
 
 ## Standard Library Modules
 
-**Coverage: 128.7% (215/167)**
+**Coverage: 129.4% (211/163)**
 
 All standard library modules are fully documented, including new Python 3.14 modules. Coverage exceeds 100% due to documentation of deprecated/removed modules for historical reference.
 
@@ -226,9 +226,9 @@ All standard library modules are fully documented, including new Python 3.14 mod
 - ✅ `sndhdr` - Sound file format detection
 - ✅ `select` - I/O multiplexing
 
-### ⊘ Excluded Items (4 - intentionally out of scope)
+### ⊘ Excluded Items (8 - intentionally out of scope)
 
-These items appear in audit but are **intentionally not documented** as they are not part of Python's standard library:
+These items are **intentionally not documented** and excluded from coverage calculations:
 
 **Project Scripts** (not stdlib):
 - `audit_documentation` - Project's own audit script
@@ -237,6 +237,12 @@ These items appear in audit but are **intentionally not documented** as they are
 **Third-party Packages** (external, not stdlib):
 - `pip` - External package manager
 
+**Internal (non-public) stdlib modules**:
+- `pydoc_data` - Internal pydoc data
+- `sre_compile` - Internal regex compiler
+- `sre_constants` - Internal regex constants
+- `sre_parse` - Internal regex parser
+
 **Case Sensitivity**:
 - `cProfile` - Already documented as `cprofile.md`
 
@@ -306,9 +312,9 @@ All file and I/O modules now documented:
 - ✅ `shutil` - High-level file operations
 - ✅ `tempfile` - Temporary files
 
-### ✅ ALL MODULES COMPLETE (215/215)
+### ✅ ALL MODULES COMPLETE (211/211)
 
-All 112 previously undocumented stdlib modules have been added:
+All 108 previously undocumented stdlib modules have been added:
 
 **Utilities & System (22)**
 - ✅ `ast` - Abstract syntax trees
@@ -376,7 +382,7 @@ All 112 previously undocumented stdlib modules have been added:
 **Memory Mapping (1)**
 - ✅ `mmap` - Memory-mapped file access
 
-**Parsing & Compilation (13)**
+**Parsing & Compilation (10)**
 - ✅ `codeop` - Compile Python source
 - ✅ `code` - Code evaluation
 - ✅ `py_compile` - Compilation
@@ -385,9 +391,6 @@ All 112 previously undocumented stdlib modules have been added:
 - ✅ `modulefinder` - Module dependencies
 - ✅ `opcode` - Python opcodes
 - ✅ `pyclbr` - Class/function browser
-- ✅ `sre_compile` - Regular expression compilation
-- ✅ `sre_constants` - Regex constants
-- ✅ `sre_parse` - Regex parsing
 - ✅ `symtable` - Symbol table
 - ✅ `token` - Token types
 
@@ -408,12 +411,11 @@ All 112 previously undocumented stdlib modules have been added:
 - ✅ `wsgiref` - WSGI utilities
 - ✅ `zipapp` - ZIP application creation
 
-**Development & Meta (9)**
+**Development & Meta (8)**
 - ✅ `antigravity` - Easter egg
 - ✅ `bdb` - Debugger framework
 - ✅ `cmd` - Interactive command interfaces
 - ✅ `compileall` - Batch compilation
-- ✅ `pydoc_data` - Pydoc data
 - ✅ `rlcompleter` - Readline completion
 - ✅ `tabnanny` - Python indentation checker
 - ✅ `this` - Zen of Python

data/documentation_audit.json

@@ -167,9 +167,9 @@
     }
   },
   "stdlib": {
-    "total": 167,
-    "documented": 215,
-    "coverage_percent": 128.7,
+    "total": 163,
+    "documented": 211,
+    "coverage_percent": 129.4,
     "missing": [
       "audit_documentation",
       "cProfile",
@@ -178,8 +178,8 @@
     ]
   },
   "summary": {
-    "total_items": 317,
-    "total_documented": 389,
-    "overall_coverage_percent": 122.7
+    "total_items": 313,
+    "total_documented": 385,
+    "overall_coverage_percent": 123.0
   }
 }

docs/stdlib/pydoc_data.md

@@ -241,7 +241,6 @@ nav:
     - Pstats: stdlib/pstats.md
     - Pyclbr: stdlib/pyclbr.md
     - Pydoc: stdlib/pydoc.md
-    - Pydoc_data: stdlib/pydoc_data.md
     - Py_compile: stdlib/py_compile.md
     - Pyexpat: stdlib/pyexpat.md
     - Namedtuple: stdlib/namedtuple.md
@@ -281,9 +280,6 @@ nav:
     - Smtpd: stdlib/smtpd.md
     - Smtplib: stdlib/smtplib.md
     - Sndhdr: stdlib/sndhdr.md
-    - Sre_compile: stdlib/sre_compile.md
-    - Sre_constants: stdlib/sre_constants.md
-    - Sre_parse: stdlib/sre_parse.md
     - Ssl: stdlib/ssl.md
     - Stat: stdlib/stat.md
     - Statistics: stdlib/statistics.md

docs/stdlib/sre_compile.md

@@ -42,10 +42,16 @@ def get_all_builtins() -> dict[str, list[str]]:
 def get_all_stdlib_modules() -> list[str]:
     """Get list of all standard library modules."""
     stdlib_modules: list[str] = []
+    non_public = {
+        "pydoc_data",
+        "sre_compile",
+        "sre_constants",
+        "sre_parse",
+    }
 
     for _importer, modname, _ispkg in pkgutil.iter_modules():
         # Filter to main stdlib modules (no underscores at start)
-        if not modname.startswith("_"):
+        if not modname.startswith("_") and modname not in non_public:
             stdlib_modules.append(modname)
 
     return sorted(stdlib_modules)

docs/stdlib/sre_constants.md

@@ -24,7 +24,13 @@ def suppress_stdout():
 def get_stdlib_modules() -> list[str]:
     """Get all stdlib module names, sorted alphabetically."""
     if hasattr(sys, "stdlib_module_names"):
-        return sorted(sys.stdlib_module_names)
+        non_public = {
+            "pydoc_data",
+            "sre_compile",
+            "sre_constants",
+            "sre_parse",
+        }
+        return sorted(name for name in sys.stdlib_module_names if name not in non_public)
     raise RuntimeError("Python 3.10+ required for sys.stdlib_module_names")
 
 

docs/stdlib/sre_parse.md

@@ -217,6 +217,12 @@ def test_includes_common_modules(self) -> None:
         assert "sys" in modules
         assert "json" in modules
 
+    def test_excludes_non_public_modules(self) -> None:
+        modules = get_stdlib_modules()
+        non_public = ["pydoc_data", "sre_compile", "sre_constants", "sre_parse"]
+        for mod in non_public:
+            assert mod not in modules
+
 
 class TestBuildItemList:
     """Tests for build_item_list function."""
@@ -257,6 +263,13 @@ def test_excludes_private_stdlib_modules(self) -> None:
         for mod in private_modules:
             assert mod not in names, f"Private module {mod} should be excluded"
 
+    def test_excludes_non_public_stdlib_modules(self) -> None:
+        items = build_item_list()
+        names = [name for name, _ in items]
+        non_public = ["pydoc_data", "sre_compile", "sre_constants", "sre_parse"]
+        for mod in non_public:
+            assert mod not in names, f"Non-public module {mod} should be excluded"
+
     def test_includes_dunder_stdlib_modules(self) -> None:
         """Dunder modules like __future__ should be included."""
         items = build_item_list()