Skip to content

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

@mcowpert

Description

@mcowpert

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions