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

Docs about flakehell baseline are misleading #1095

Closed
sobolevn opened this issue Dec 28, 2019 · 8 comments
Closed

Docs about flakehell baseline are misleading #1095

sobolevn opened this issue Dec 28, 2019 · 8 comments
Labels
bug Something isn't working dependencies Pull requests that update a dependency file documentation Docs related task help wanted Extra attention is needed level:starter Good for newcomers

Comments

@sobolevn
Copy link
Member

sobolevn commented Dec 28, 2019

Bug report

What's wrong

Docs about flakehell misses the configuration part for pyproject.toml as stated in cherrypy/cheroot#253 (comment)

Problematic page: https://wemake-python-stylegui.de/en/latest/pages/usage/integrations/flakehell.html

It misses [tool.flakehell.plugins] part.

How is that should be

We need to fix that: our docs should have all the required steps to get started.

@sobolevn sobolevn added the bug Something isn't working label Dec 28, 2019
@sobolevn sobolevn added this to the Version 0.13.x milestone Dec 28, 2019
@sobolevn sobolevn added dependencies Pull requests that update a dependency file documentation Docs related task help wanted Extra attention is needed level:starter Good for newcomers labels Dec 28, 2019
@sobolevn
Copy link
Member Author

CC @orsinium

@orsinium
Copy link
Collaborator

orsinium commented Dec 30, 2019

I think the best option is to make default flakehell config in styles and use it as base config:

[tool.flakehell]
base = "https://raw.githubusercontent.com/wemake-services/wemake-python-styleguide/master/styles/flakehell.toml"

The motivation is wemake has a lot of dependent plugins that have to be explicitly specified for flakehell:

[tool.flakehell.plugins]
wemake-python-styleguide = ["+*"]
flake8-builtins = ["+*"]
...

@orsinium
Copy link
Collaborator

To make base config url nicer, you can use redirect page: https://wemake-python-stylegui.de/flakehell.toml

@webknjaz
Copy link
Contributor

@orsinium I'm pretty sure RTD can't do native HTTP redirects.

@orsinium
Copy link
Collaborator

If I understand correctly, wemake-python-stylegui.de uses CloudFlare as a proxy. So, the redirect can be set up there.

@orsinium
Copy link
Collaborator

Oh, and RTD can do redirects as well: https://readthedocs.org/dashboard/PROJECT_NAME/redirects/

@webknjaz
Copy link
Contributor

RTD itself uses CloudFlare and this is how you saw their name in the TLS certificate. There's no controls for it.

@webknjaz
Copy link
Contributor

RTD can do redirects as well

Oh, TIL.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working dependencies Pull requests that update a dependency file documentation Docs related task help wanted Extra attention is needed level:starter Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants