Skip to content

revert: remove derivative prose from the pyzeroconf era - #1847

Merged
bdraco merged 2 commits into
masterfrom
remove_derivative_prose
Aug 29, 2026
Merged

bdraco merged 2 commits into
masterfrom
remove_derivative_prose

Conversation

@bdraco

@bdraco bdraco commented Aug 29, 2026

Copy link
Copy Markdown
Member

Summary

Second removal pass for #1835. The first audit was built from git blame with move and copy detection, which credits whoever last edited a line; docstrings from the 2009 tree that later authors lightly edited were attributed to the editor and survived #1843. A blame independent check that compares the current tree textually against the 2009 pyzeroconf tree and the 2014 v0.14-wmcbrine tree found the remainder: about fifty docstrings across the library and async API that still share six word or longer runs with the original prose, the flag bit trailing comments in const.py, and two example files whose docstrings derive from the original zwebbrowse and zwebtest scripts; the two examples are deleted whole and will be recreated fresh in the follow up.

This PR is deletion only and is intentionally aggressive; every docstring containing any matching run is deleted whole rather than trimmed, so the follow up restores from a clean slate. Several public members lose their rendered API documentation until the follow up PR adds freshly written docstrings.

Test plan

  • every file still parses and the suite passes; the deletions are prose only
  • the textual comparison against both historical trees now reports zero matching prose spans outside the license headers, which are replaced wholesale by the relicense itself

@github-actions

Copy link
Copy Markdown

Thanks for contributing! A quick note: this project is in the process of moving from LGPL-2.1 to Apache 2.0, see #1835.

By continuing with this pull request you are okay with your contribution, and your previous contributions to this repository, being offered under Apache 2.0.

If that does not work for you, no hard feelings; reply with the exact phrase I do not agree to the Apache 2.0 license or simply close this pull request, and nothing of yours will be included in the change.

@codspeed

codspeed Bot commented Aug 29, 2026

Copy link
Copy Markdown

Merging this PR will not alter performance

✅ 24 untouched benchmarks


Comparing remove_derivative_prose (8d1e51e) with master (55061e7)

Open in CodSpeed

@codecov

codecov Bot commented Aug 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.87%. Comparing base (55061e7) to head (8d1e51e).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1847   +/-   ##
=======================================
  Coverage   99.87%   99.87%           
=======================================
  Files          33       33           
  Lines        3882     3882           
  Branches      567      567           
=======================================
  Hits         3877     3877           
  Misses          3        3           
  Partials        2        2           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bdraco
bdraco marked this pull request as ready for review August 29, 2026 19:34
@bdraco
bdraco merged commit 6eabbc3 into master Aug 29, 2026
39 checks passed
@bdraco
bdraco deleted the remove_derivative_prose branch August 29, 2026 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant