Audit docs, drop dead code, add snippet linter#65
Merged
Conversation
Fix two stale identifier references (Py_GIL_OWN, multi_executor fallback), delete priv/_erlang_impl/_ssl.py and three uncalled py_util/0,1,2,3 exports, and repair a broken SharedDict example in docs/shared-dict.md. Add tests for py:cast/4, py:async_gather/2 and py:dup_fd/1, plus test/coverage_audit.md mapping every public API to its suite. New scripts/lint_doc_snippets.escript validates py:Fn/N calls and Python syntax in fenced blocks; wired into CI and a Makefile target.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Py_GIL_OWN->PyInterpreterConfig_OWN_GILindocs/scalability.md; correctedmulti_executorfallback claim indocs/migration.md).priv/_erlang_impl/_ssl.py(no importer) and three uncalledpy_utilexports (send_response/3,normalize_timeout/1,2).docs/shared-dict.md(missing close paren and a non-functional handle-injection pattern).py:cast/4,py:async_gather/2, andpy:dup_fd/1; addtest/coverage_audit.mdmapping every public API to its test suite.scripts/lint_doc_snippets.escriptvalidatespy:Fn/Ncalls and Python syntax in fenced blocks; wired into aMakefiletarget and CI. Snippets that intentionally show removed APIs or REPL output use<!-- skip-lint -->.Verification:
rebar3 ct436/436 pass,rebar3 xrefclean,rebar3 dialyzerclean,make lint-docsclean across 26 docs.