canonical / canonical/canonicalwebteam.docstring-extractor

Incompatibility between flake8 and black in the pipeline

Open
#41 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
1
Forks
3
PR merge metrics
No merged PRs in 30d

Description

In the pipeline, black and flake8 are conflicting.

It asks to format with black:
```
python3 -m flake8 canonicalwebteam && python3 -m black --line-length 79 --check canonicalwebteam
would reformat /Users/jnaves/code/canonicalwebteam.docstring-extractor/canonicalwebteam/docstring_extractor/__init__.py

Oh no! 💥 💔 💥
1 file would be reformatted, 1 file would be left unchanged.
```

then we format it

```
python3 -m black --line-length 79 canonicalwebteam
reformatted /Users/jnaves/code/canonicalwebteam.docstring-extractor/canonicalwebteam/docstring_extractor/__init__.py

All done! ✨ 🍰 ✨
1 file reformatted, 1 file left unchanged.
```

Now flake8 complains about E203

```
python3 -m flake8 canonicalwebteam && python3 -m black --line-length 79 --check canonicalwebteam
canonicalwebteam/docstring_extractor/__init__.py:28:35: E203 whitespace before ':'
canonicalwebteam/docstring_extractor/__init__.py:33:63: E203 whitespace before ':'
canonicalwebteam/docstring_extractor/__init__.py:35:47: E203 whitespace before ':'
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by running the flake8 and black commands shown in the issue, then inspect canonicalwebteam/docstring_extractor/__init__.py at the reported lines. Check the pipeline's lint configuration and make the two checks agree; done means the reported E203 errors are gone and both commands pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
ci-cd, tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.