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.

Sign up for GitHub

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

Jump to bottom

importing a module for get_checkers is not documented #46

Open
micahjohnson150 opened this issue Feb 25, 2020 · 0 comments
Open

importing a module for get_checkers is not documented #46

micahjohnson150 opened this issue Feb 25, 2020 · 0 comments
Assignees
@micahjohnson150
Labels
bug Something isn't working documentation Additional documentation is needed enhancement New feature or request

Comments

@micahjohnson150
Copy link
Collaborator

  • inicheck version: 0.7.8

Description

Currently when adding custom checkers, the documentation says to simply add the module name to the the init.py . This does however assume that where ever get_user_config or anything else that uses get_checkers is, that the module being referenced is actively loaded.

The fix, is to add an exception with an appropriate warning and document it
@micahjohnson150 micahjohnson150 added bug Something isn't working enhancement New feature or request documentation Additional documentation is needed labels Feb 25, 2020
@micahjohnson150 micahjohnson150 self-assigned this Feb 25, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@micahjohnson150 micahjohnson150

Labels
bug Something isn't working documentation Additional documentation is needed enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@micahjohnson150