Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add flake8-pytest-style to plugin_list.rst #10939

Merged
merged 6 commits into from
Apr 28, 2023

Conversation

sergkim13
Copy link
Contributor

Hello! This is my first PR in opensource project. Please, don't judge me harshly.

This PR closes #10709 by adding flake8-pytest-style to plugin_list.rst.

Copy link
Member

@RonnyPfannschmidt RonnyPfannschmidt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this file is autogenerated, unless you we add a extra condition to the script that creates it, the weekly update will just drop it out again

@RonnyPfannschmidt
Copy link
Member

i recommend waiting a little with the script as i'm about to fixup and merge #10927

@The-Compiler
Copy link
Member

To me, this seems like the wrong place entirely for this anyways - after all, this is not a pytest plugin, it's a plugin for the flake8 linter. As I suggested in #10709 already, I think the Good Practices page in the docs would be the perfect place for this.

@sergkim13
Copy link
Contributor Author

So should I remove it from plugin_list.rst and add short description about flake8-pytest-style to the bottom of goodpractices.rst, right?

@The-Compiler
Copy link
Member

That's what I would recommend, yep!

@sergkim13
Copy link
Contributor Author

Added mention about flake8-pytest-style to the goodpractices.rst. I would appreciate a review!

Copy link
Member

@bluetech bluetech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @sergkim13, I think this can help users better use pytest.

However, since this appears in the official "good practices" doc, I think it's necessary to add a note like this:

Disclaimer: flake8-pytest-style is not an official pytest project.

@bluetech
Copy link
Member

cc @m-burst, author of flake8-pytest-style, if you have any comments let us know!

@sergkim13
Copy link
Contributor Author

@bluetech, done!

Copy link
Member

@bluetech bluetech left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @sergkim13. I hope your first open source contribution went well and won't be your last :)

@m-burst
Copy link

m-burst commented Apr 28, 2023

I want to add my 2 cents as the author of flake8-pytest-style.
There is a common caveat: one of the rules enforces a code style that differs from examples in pytest docs (namely @pytest.fixture() vs @pytest.fixture) unless the plugin is explicitly configured otherwise.
Maybe this should be mentioned here.

@bluetech
Copy link
Member

bluetech commented Apr 28, 2023

@m-burst @sergkim13 What do you think about the following?

flake8-pytest-style is not an official pytest project. Some of the rules enforce certain style choices, such as using @pytest.fixture() over @pytest.fixture, but you can configure the plugin to fit your preferred style.

@bluetech bluetech merged commit 725de3a into pytest-dev:main Apr 28, 2023
25 checks passed
@sergkim13 sergkim13 deleted the issue-10709-update-plugin-list branch April 29, 2023 07:48
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.

Docs request: inclusion of flake8-pytest-style
5 participants