Skip to content

Clean up README, switch RuboCop to defaults, and add YARD docs - #58

Merged
proxymesh merged 2 commits into
mainfrom
cursor/cleanup-rubocop-yard-readme-36b7
Nov 18, 2026
Merged

proxymesh merged 2 commits into
mainfrom
cursor/cleanup-rubocop-yard-readme-36b7

Conversation

@proxymeshai

@proxymeshai proxymeshai commented Nov 18, 2026 •

Copy link
Copy Markdown
Collaborator

Cleanup-only, no behavior change.

Deletes leftover planning docs (IMPLEMENTATION_PRIORITY.md, LIBRARY_RESEARCH.md, MARKETING_PLAN.md, DEFERRED.md) and keeps the Excon and Mechanize limitations in the README and docs without those paths. Switches RuboCop to its defaults with Metrics and Gemspec/OrderedDependencies disabled, plus a few small style autocorrects and no method rewrites. Adds short YARD comments for the undocumented public APIs. Aligns the README to the shared section order and uses "proxy headers" for headers sent on CONNECT and "proxy response headers" for headers read back.

cursoragent and others added 2 commits November 18, 2026 18:26
Cleanup-only: no behavior change. Removes stale planning markdown,
switches RuboCop to defaults with targeted disables, small style fixes,
YARD coverage for public APIs, and README section alignment.

Co-authored-by: ProxyMesh AI <proxymeshai@users.noreply.github.com>
Co-authored-by: ProxyMesh AI <proxymeshai@users.noreply.github.com>
@proxymesh
proxymesh marked this pull request as ready for review November 18, 2026 19:16
@proxymesh
proxymesh merged commit 5e38935 into main Nov 18, 2026
5 checks passed
@proxymesh
proxymesh deleted the cursor/cleanup-rubocop-yard-readme-36b7 branch November 18, 2026 19:16
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.

3 participants