From 8c16776d72f2b1fe3e613fb78e1278a8f19cf6f5 Mon Sep 17 00:00:00 2001 From: Kenneth Reitz Date: Fri, 23 Mar 2012 16:13:43 -0400 Subject: [PATCH] documentation improvements --- bin/compile | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/bin/compile b/bin/compile index ddd32b5..43986f5 100755 --- a/bin/compile +++ b/bin/compile @@ -1,8 +1,10 @@ #!/usr/bin/env bash -# This script serves as the **Python Buildpack** compiler. +# This script serves as the +# [**Python Buildpack**](https://github.com/heroku/heroku-buildpack-python) +# compiler. # -# A [buildpack](http://devcenter.heroku.m/articles/buildpacks) is an +# A [buildpack](http://devcenter.heroku.com/articles/buildpacks) is an # adapter between a Python application and Heroku's runtime. # ## Usage @@ -35,7 +37,7 @@ ROOT_DIR=$(dirname $BIN_DIR) BUILD_DIR=$1 CACHE_DIR=$2 -# The detected application type (Python|Python/Django). +# The detected application type (`Python`|`Python/Django`). NAME=$($BIN_DIR/detect $BUILD_DIR) # Where to store the Pip download cache. @@ -44,7 +46,7 @@ PIP_DOWNLOAD_CACHE=${PIP_DOWNLOAD_CACHE:-$CACHE_DIR/pip_downloads} # The directories to include in the cache. VIRTUALENV_DIRS="bin include lib" -# Python versions. This will be used in the future to specify custom Pythons. +# Python version. This will be used in the future to specify custom Pythons. PYTHON_VERSION="2.7.2" PYTHON_EXE="python2.7" @@ -125,13 +127,13 @@ echo "$OUT" | indent set -e -# Create set-aside .heroku folder. +# Create set-aside `.heroku` folder. mkdir -p .heroku # Pylibmc support. source $BIN_DIR/steps/pylibmc -# Activate the virtualenv. +# Activate the Virtualenv. echo "-----> Activating virtualenv" source bin/activate @@ -141,7 +143,7 @@ if [ ! -f requirements.txt ]; then echo "-e ." > requirements.txt fi -# Install Mercurial, if it appears to be required. +# Install Mercurial if it appears to be required. if (grep -Fiq "hg+" requirements.txt) then pip install --use-mirrors mercurial | indent fi