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

Add more clarity to the packaging tutorial dir structure #583

Merged
merged 2 commits into from
Jan 2, 2019
Merged

Add more clarity to the packaging tutorial dir structure #583

merged 2 commits into from
Jan 2, 2019

Conversation

dogweather
Copy link
Contributor

@dogweather dogweather commented Dec 31, 2018

The tutorial begins by instructing the reader to create this confusing hierarchy without explanation:

example_pkg/
    example_pkg/
        __init__.py

The tutorial then continues on, referring to example_pkg frequently, but not clarifying which one is meant. Confusing! And not necessary, in my opinion. So this PR renames the top-level dir, better describing its purpose:

packaging_tutorial/
    example_pkg/
        __init__.py

@ncoghlan
Copy link
Member

@theacodes This change seems like a good idea to me - the current structure came from the fact that in a typical single-package project the VCS repo and the top-level Python import package share a name (so you end up with this doubly-nested layout), but for someone running through the tutorial in a throwaway directory, that reasoning doesn't apply.

@theacodes
Copy link
Member

Agreed. Thanks for doing this, @dogweather!

@theacodes theacodes merged commit 660ea67 into pypa:master Jan 2, 2019
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

Successfully merging this pull request may close these issues.

3 participants