Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sobolevn committed Jul 19, 2019
1 parent acf6348 commit 0a335e1
Showing 1 changed file with 2 additions and 63 deletions.
65 changes: 2 additions & 63 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,71 +47,10 @@ flake8 your_module.py

## Output example

### Without aggressive mode
Here's how output looks like (we are using [`wemake` formatter](https://wemake-python-stylegui.de/en/latest/pages/formatter.html)):

```diff
» flake8 tests/fixtures/incorrect.py
tests/fixtures/incorrect.py:1:1: E800: Found commented out code:
--- before/tests/fixtures/incorrect.py
+++ after/tests/fixtures/incorrect.py
@@ -1,23 +1,16 @@
![flake8-eradicate output](https://raw.githubusercontent.com/sobolevn/flake8-eradicate/master/eradicate.png)

class Some(object):
- # property_name = 1
- # typed_property: int = 10
other_property = 2


# def function_name():
-# return None


# class CommentedClass(object):
# def __init__(self, prop: int) -> None:
-# self.property = prop

# def __str__(self) -> str:
-# return self.__class__.__name__

# def set_prop(self, prop: int):
-# self.prop = prop

# def get_prop(self):
-# return self.prop
```

### With aggresive mode

```diff
» flake8 --eradicate-aggressive tests/fixtures/incorrect.py
tests/fixtures/incorrect.py:1:1: E800: Found commented out code:
--- before/tests/fixtures/incorrect.py
+++ after/tests/fixtures/incorrect.py
@@ -1,23 +1,10 @@

class Some(object):
- # property_name = 1
- # typed_property: int = 10
other_property = 2


-# def function_name():
-# return None


-# class CommentedClass(object):
-# def __init__(self, prop: int) -> None:
-# self.property = prop

-# def __str__(self) -> str:
-# return self.__class__.__name__

-# def set_prop(self, prop: int):
-# self.prop = prop

-# def get_prop(self):
-# return self.prop
```

## License

Expand Down

0 comments on commit 0a335e1

Please sign in to comment.