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

Check if Sherlock is package or script at runtime #2204

Closed
1 of 3 tasks
ppfeister opened this issue Jun 28, 2024 · 0 comments · Fixed by #2213
Closed
1 of 3 tasks

Check if Sherlock is package or script at runtime #2204

ppfeister opened this issue Jun 28, 2024 · 0 comments · Fixed by #2213
Assignees
Labels
enhancement New feature or request

Comments

@ppfeister
Copy link
Member

Description

Many tutorials and walkthroughs exist for Sherlock, and they all use the old not-really-installed "install" method. With this, after the transition to a proper installable package, many users have opened bug reports relating to failed imports, when following these now outdated guides.

One of two things should happen to alleviate this --

  • Choose at runtime between proper module imports and relative script imports
  • Test at runtime if Sherlock is being ran as a package or as a script, and display a more informative error message if as a script

The former is more "friendly" in that it allows for old-style use, but the latter is more "proper" in my mind and more assertive in its use as a package. I lean towards the latter.

Code of Conduct

  • I agree to follow this project's Code of Conduct
@ppfeister ppfeister added the enhancement New feature or request label Jun 28, 2024
@ppfeister ppfeister moved this to Backlog in Release 0.15.0 Jun 28, 2024
@ppfeister ppfeister self-assigned this Jun 30, 2024
@ppfeister ppfeister moved this from Backlog to In review in Release 0.15.0 Jul 1, 2024
@ppfeister ppfeister moved this from In review to Approved in Release 0.15.0 Jul 8, 2024
@github-project-automation github-project-automation bot moved this from Approved to Done in Release 0.15.0 Jul 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant