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

[addition] List common mistakes/antipatterns #86

Open
henryiii opened this issue Oct 7, 2020 · 3 comments
Open

[addition] List common mistakes/antipatterns #86

henryiii opened this issue Oct 7, 2020 · 3 comments

Comments

@henryiii
Copy link
Member

henryiii commented Oct 7, 2020

We should list a few things that you should not do, like using setup.py directly, especially not setup.py test, which is discouraged and deprecated. Maybe include common mistakes, like accidentally included the "tests" folder in the install (or maybe even the SDist).

@eduardo-rodrigues
Copy link
Member

Hi @henryiii, I wonder if this is not effectively done via all the developer pages you have prepared? If so, better close and "clean-up".

@henryiii
Copy link
Member Author

This would be a developer pages addition with "antipatterns", which we don't have yet. Or maybe each page could end with antipatterns?

@eduardo-rodrigues
Copy link
Member

I would actually go with antipatterns related that the various devel pages, yes. This way a person can see the examples while being made aware of what are bad practices. A single page may be too much of a mix and less clear in the end.

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

No branches or pull requests

2 participants