PyCQA / PyCQA/eradicate

Add "EXAMPLE" to whitelist

Open
#40 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
218
Forks
26
PR merge metrics
No merged PRs in 30d

Description

Could you please add "EXAMPLE" to the built-in whitelist? This would allow to have some code examples as comments.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the built-in whitelist in the eradicate codebase and inspect how comment tokens are checked against it. Add EXAMPLE to that whitelist and verify that code examples using it in comments are preserved while other commented-out code is still removed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.