hatch icon indicating copy to clipboard operation
hatch copied to clipboard

Document where Hatch puts files, all in one place

Open pfmoore opened this issue 2 years ago • 2 comments

In addition to the project directory, I believe hatch puts files in various places - the environments it creates, the Python versions it downloads, etc. It would be useful to have a complete list of places hatch puts files[^1] in a single page in the documentation, to aid in cleanly uninstalling hatch if needed, as well as allowing users who prefer to keep files in custom locations to know exactly what needs to be changed.

At the moment, to get this information, it's necessary to search through the docs, and there's no way to be sure you didn't miss something.

[^1]: Including links to the relevant config files that let you change those locations.

pfmoore avatar Dec 12 '23 11:12 pfmoore

Everything is documented here https://hatch.pypa.io/latest/config/hatch/#directories

Is there something I could do to make that more clear?

ofek avatar Dec 12 '23 14:12 ofek

I guess it covers everything. Although it's looking at it from the perspective of "what can I configure" rather than "where does hatch store stuff" - so it's not particularly discoverable if you're thinking in terms of where things are put. Also, there's a config.toml file mentioned here which isn't covered by this list. Yes, that file is user created, not created by hatch, but I still consider it as a "file that hatch uses".

I can't say I find the descriptions in that section very helpful, though. The data directory "is the directory that is used to persist data". Well, yes, I guess so. But what data? If I delete that directory, what data will be lost? What impact will that have? How much data should I expect to be in that directory? Do I need to back it up when I back up my projects, etc?

If there was a documentation section on how to uninstall hatch, that explained what you'd have to clear up, that would have been easier for me to find from the question I was starting with. It's not precisely that I wanted to uninstall (it's more generally about managing my disk storage), but it's closely enough related that I'd have found the information if it was there. Whereas I wouldn't think to look in "Configuration" for that information.

pfmoore avatar Dec 12 '23 15:12 pfmoore