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

Tutorial in README doesn't match code in example #32

Open
mcowpert opened this issue Mar 11, 2022 · 0 comments
Open

Tutorial in README doesn't match code in example #32

mcowpert opened this issue Mar 11, 2022 · 0 comments

Comments

@mcowpert
Copy link

Most of the tutorial in the README works as written, but it's never clear why path is introduced mypkg. But at the end of the tutorial is this:

the underlying modules are also accessible, for example:
from mypkg.sub import Class1

sub does not appear in the sample code, and this sample line fails for a reader following along.

However, the code in example/mypkg/__init__.py does introduce sub and no longer uses path. This is a better example!
It would be an improvement if that example file were merged into the README, and the corresponding usage excerpt were updated to match.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants