Add initial draft of src vs flat layout discussion #1150
Conversation
pradyunsg
force-pushed
the
add-src-non-src-discussion
branch
from
a4b8fc8 to
cfad34a
Compare
|
This still needs a bunch of cross references to be added, and a round of copy-editing. |
This serves to document the behaviour differences between the src layout and the flat layout, and how they might matter to users.
There was a problem hiding this comment.
This feels like the right sort of level to me - discuss the trade-offs but keep it simple.
I'm assuming that this section is not where we offer a recommendation. The fact that https://packaging.python.org/en/latest/tutorials/packaging-projects/ uses the src layout is where our recommendation is stated (implicitly).
FWIW, I'm personally not going to get into the recommendations rabbit hole for this right now. That'll be someone else's problem or future me's problem, when I come around to this site after https://github.com/pradyunsg/lutra/ is good to go. |
pradyunsg
force-pushed
the
add-src-non-src-discussion
branch
from
cfad34a to
3c0750f
Compare
This rewords certain bits and fixes typos.
|
This is good to go from my end. If I could get a couple of approvals on this, I’m happy to land this myself. I am also more than happy to trust the judgement of currently-active maintainers on the guide, if they want to land this sooner. :) |
There was a problem hiding this comment.
This looks good to me.
As I recall, a big part of the discussion around this related to test files, where people like to put them, whether they get installed as part of the package or not, and whether you ever want to test the source package as opposed to the installed package. I don't think you need to tackle that topic in this PR, but I imagine it might get added at some point. 🙂
It certainly was! I wanted to start with the unambigous bits and I'm gonna be cautious and not take implicit dibs on the task of expanding this to cover test layouts. It might be an idea to have that discussion in a separate file even. |
x-ref #320
This discussion covers the main topics discussed in #320, trimming the opinions/preferences stated there and keeping things limited to the behaviour differences between the two formats. I've followed the same style as pip vs easy_install or wheel vs egg pages here.