justinmayer / virtualfish

Fish shell tool for managing Python virtual environments
MIT License
1.06k stars 100 forks source link

Document workon alias behavior with Projects plugin #151

Closed bpeterso2000 closed 5 years ago

bpeterso2000 commented 5 years ago

The purpose of this change is to help users understand how to get workonbehaving similar to virtualenvwrapper'sworkonwhen the compat_aliasesandprojects` plugins are used together.

So the order the two plugins are listed (i.e., loaded) matters, and so does whether or not the VIRTUALFISH_COMPAT_ALIASES environment variable is set.

If VIRTUALFISH_COMPAT_ALIASES is not set before the projects plugin is loaded or the compat_aliases is loaded after the project plugin then workon will activate the virtual environtment, but will not automatically change to the project directory.

See issue #137

justinmayer commented 5 years ago

Thank you for the thorough description of the current situation as well as the clear motivation for the contributed documentation enhancement. Much appreciated!