search

ofek / userpath

Cross-platform tool for adding locations to the user PATH, no elevated privileges required!
MIT License
151 stars 20 forks source link

Concrete documentation of side-effects from tool #17

Open buckley-w-david opened 4 years ago

buckley-w-david commented 4 years ago

For context: Linux user

I think this project would benefit to some documentation as to what the tool actually does, as in what files it modifies and how. After making a mistaken addition using the tool, I had to spend a few minutes searching through the source code to find what it actually does so that I could revert it, since there's no reference (that I could find) as to how it actually goes about adding entries to the path within the help, or in the README.

Eventually I found https://github.com/ofek/userpath/blob/307894621bc4d94565845851190de086372138ab/userpath/shells.py#L37 Letting me know that I would likely find the answer in my .bashrc file. I don't think users should be expected to navigate the source tree to figure out what the tool is actually doing, as right now the only documentation simply says "Appends to the user PATH", which is fine for a description of functionality but lacking for a detailed explanation.

I know I probably should have assumed that it was appending a line to my .bashrc file, but I still think that a bit of documentation would be helpful.