2323#
2424
2525# Make sure there is a default value for WORKON_HOME.
26+ # You can override this setting in your .bashrc.
2627if [ "$WORKON_HOME" = "" ]
2728then
2829 export WORKON_HOME="$HOME/.virtualenvs"
@@ -38,13 +39,17 @@ function verify_workon_home () {
3839 return 0
3940}
4041
41- # Function to create a new environment, in the WORKON_HOME.
42+ # Create a new environment, in the WORKON_HOME.
43+ #
44+ # Usage: mkvirtualenv [options] ENVNAME
45+ # (where the options are passed directly to virtualenv)
46+ #
4247function mkvirtualenv () {
4348 verify_workon_home
4449 (cd "$WORKON_HOME"; virtualenv $*)
4550}
4651
47- # Function to remove an environment, in the WORKON_HOME.
52+ # Remove an environment, in the WORKON_HOME.
4853function rmvirtualenv () {
4954 typeset env_name="$1"
5055 verify_workon_home
@@ -57,13 +62,16 @@ function rmvirtualenv () {
5762 rm -rf "$env_dir"
5863}
5964
60- # Function to list the available environments.
65+ # List the available environments.
6166function show_workon_options () {
6267 verify_workon_home
6368 ls "$WORKON_HOME" | egrep -v '*.egg' | sort
6469}
6570
66- # Function to list or change working virtual environments
71+ # List or change working virtual environments
72+ #
73+ # Usage: workon [environment_name]
74+ #
6775function workon () {
6876 typeset env_name="$1"
6977 if [ "$env_name" = "" ]
0 commit comments