Summary
After landing the recent go-parity / polish PRs (#136–#144), a clean checkout of master fails local PR gates:
make pr / ruff — tests/test_protocols.py uses a non-raw match= pattern with regex metacharacters (RUF043).make docs / Sphinx -W — multiaddr.utils.from_net_addr docstring has a multi-line Args definition list that Sphinx treats as a warning-as-error.- Docs inventory —
docs/multiaddr.rst (sphinx-apidoc) does not yet list the new multiaddr.filters module.
Expected
make pr passesmake docs / make docs-ci passes with SPHINXOPTS="-W"
Proposed fix
- Use a raw-string regex in the wg negative test (
match=r"...")
- Flatten the
from_net_addr Args docstring to a single-line description
- Add
multiaddr.filters automodule section to docs/multiaddr.rst
Notes
A direct commit previously landed these changes on master without GitHub tox CI (workflow only runs on pull_request and pushes to main / github-actions). This issue tracks landing the same fix via a proper PR so Actions can validate it.
Summary
After landing the recent go-parity / polish PRs (#136–#144), a clean checkout of
masterfails local PR gates:make pr/ ruff —tests/test_protocols.pyuses a non-rawmatch=pattern with regex metacharacters (RUF043).make docs/ Sphinx-W—multiaddr.utils.from_net_addrdocstring has a multi-line Args definition list that Sphinx treats as a warning-as-error.docs/multiaddr.rst(sphinx-apidoc) does not yet list the newmultiaddr.filtersmodule.Expected
make prpassesmake docs/make docs-cipasses withSPHINXOPTS="-W"Proposed fix
match=r"...")from_net_addrArgs docstring to a single-line descriptionmultiaddr.filtersautomodule section todocs/multiaddr.rstNotes
A direct commit previously landed these changes on
masterwithout GitHub tox CI (workflow only runs onpull_requestand pushes tomain/github-actions). This issue tracks landing the same fix via a proper PR so Actions can validate it.