(docs) Update README with cleaned junk categories#25
Conversation
|
Thanks for your first pull request to Sifty! A couple of things that help it land quickly: Sifty deletes files, so all deletion must go through |
|
Hello, your PR #24 has been successfully merged. Could you please bump the count to 12 and add it to this list? |
|
Updated! I included |
Vortrix5
left a comment
There was a problem hiding this comment.
Thanks for picking this up, but the list doesn't match the actual categories in src/sifty/core/junk.py and needs a redo before it can go in.
It lists four that don't exist anywhere in the code: delivery-optimization, branchcache, log-files, and recycle-bin. And it misses several real ones: thumbnail-cache, winget-cache, event-log-archives, defender-history, onedrive-logs, and windows-old (off by default). One small thing too: browser-cache also covers Brave/Vivaldi/Firefox, not just Chrome/Edge.
Easiest fix is to generate the list straight from junk_categories() so it stays accurate, ideally grouped by always-on vs off-by-default (downloads-installers, windows-old) and which ones need admin. Happy to re-review once it matches the code.
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment Thanks for integrating Codecov - We've got you covered ☂️ |
|
Sorry about that, I missed it the first time. I've redone the list from scratch using |
Vortrix5
left a comment
There was a problem hiding this comment.
The category list itself is fixed now, nice work, it matches junk_categories() and the always-on vs off-by-default split is exactly right.
The rebase dragged in some unrelated stuff though, so it's not mergeable as docs-only yet. Three things:
- It removes the PyPI and Codecov badges from the README header. main still has both, so this would delete them. Please put them back.
- It also carries the thousands-separator CLI change across 11 files. That's #23, which is already merged to main. Rebasing onto the latest main should drop those (they're identical), leaving just the README change.
- The "How it compares" table got reformatted (column padding, metadata to metadata), looks like a markdown formatter ran. Can you revert that so the diff is only the new section? Keeps it reviewable.
Once it's back to a docs-only diff with the badges intact, happy to merge. Thanks for turning the list around.
d80172c to
e7e572d
Compare
e7e572d to
003e5dd
Compare
|
Synced with latest |
What does this PR do?
This PR addresses the issue requesting a documented list of the junk categories covered by
sifty junk scaninside the README. It adds a clear bulleted list explaining each of the 11 core categories and highlights which one is disabled by default.Closes #21
Notes for the reviewer
main.discord-cachecategory from this list for the moment to avoid dependency conflicts with my other pending PR((feat) add Discord cache category to junk cleaner #24 ). Once the Discord cache PR is merged intomain, I will gladly open a quick follow-up commit/PR to bump the count to 12 and add it to this list.