Steve Piercy
2013-11-20 a767d8b0a54b4e93515c3faa4348bc4a34eed0cb
improve grammar and remove slang
1 files modified
32 ■■■■ changed files
HACKING.txt 32 ●●●● patch | view | raw | blame | history
HACKING.txt
@@ -6,9 +6,9 @@
Using a Development Checkout
----------------------------
You'll have to create a development environment to hack on Pyramid, using a
Pyramid checkout.   You can either do this by hand or, if you have ``tox``
installed (it's on PyPI), you can (ab)use tox to get a working development
You'll have to create a development environment to hack on Pyramid, using a
Pyramid checkout.   You can either do this by hand or, if you have ``tox``
installed (it's on PyPI), you can (ab)use tox to get a working development
environment.  Each installation method is described below.
By Hand
@@ -25,15 +25,15 @@
   $ cd ~/hack-on-pyramid
   $ virtualenv -ppython2.7 env
  Note that very old versions of virtualenv (virtualenv versions below, say,
  Note that very old versions of virtualenv (virtualenv versions below, say,
  1.10 or thereabouts) require you to pass a ``--no-site-packages`` flag to
  get a completely isolated environment.
  You can choose which Python version you want to use by passing a ``-p``
  You can choose which Python version you want to use by passing a ``-p``
  flag to ``virtualenv``.  For example, ``virtualenv -ppython2.7``
  chooses the Python 2.7 interpreter to be installed.
  From here on in within these instructions, the ``~/hack-on-pyramid/env``
  From here on in within these instructions, the ``~/hack-on-pyramid/env``
  virtual environment you created above will be referred to as ``$VENV``.
  To use the instructions in the steps that follow literally, use the
  ``export VENV=~/hack-on-pyramid/env`` command.
@@ -132,7 +132,7 @@
- PEP8 compliance.  Whitespace rules are relaxed: not necessary to put
  2 newlines between classes.  But 80-column lines, in particular, are
  mandatory.  See
  mandatory.  See
  http://docs.pylonsproject.org/en/latest/community/codestyle.html for more
  information.
@@ -142,14 +142,14 @@
Running Tests
--------------
- To run all tests for Pyramid on a single Python version, run ``nosetests``
- To run all tests for Pyramid on a single Python version, run ``nosetests``
  from your development virtualenv (See *Using a Development Checkout* above).
- To run individual tests (i.e. during development) you can use a regular
  expression with the ``-t`` parameter courtesy of the `nose-selecttests
  <https://pypi.python.org/pypi/nose-selecttests/>`_ plugin that's been
  installed (along with nose itself) via ``python setup.py dev``. The
  easiest usage is to simply provide the verbatim name of the test you're
  <https://pypi.python.org/pypi/nose-selecttests/>`_ plugin that's been
  installed (along with nose itself) via ``python setup.py dev``. The
  easiest usage is to simply provide the verbatim name of the test you're
  working on.
- To run the full set of Pyramid tests on all platforms, install ``tox``
@@ -191,8 +191,8 @@
To build and review docs (where ``$VENV`` refers to the virtualenv you're
using to develop Pyramid):
1. After following the steps above in "Using a Development Checkout", cause
   Sphinx and all development requirements to be installed in your
1. After following the steps above in "Using a Development Checkout", cause
   Sphinx and all development requirements to be installed in your
   virtualenv::
     $ cd ~/hack-on-pyramid
@@ -212,9 +212,9 @@
     $ cd ~/hack-on-pyramid/pyramid/docs
     $ make clean html SPHINXBUILD=$VENV/bin/sphinx-build
   The ``SPHINXBUILD=...`` is there to tell it to use the virtualenv Python,
   which will have both Sphinx and Pyramid (for API documentation
   generation) installed.
   The ``SPHINXBUILD=...`` argument tells Sphinx to use the virtualenv Python,
   which will have both Sphinx and Pyramid (for API documentation generation)
   installed.
4. Open the ``docs/_build/html/index.html`` file to see the resulting HTML
   rendering.