Skip to content

Commit

Permalink
Various small updates and changes in the docs
Browse files Browse the repository at this point in the history
Including style changes, rewording a few things,
and removing outdated advice.
  • Loading branch information
Zac-HD committed May 10, 2017
1 parent 50e6dc0 commit 436ad29
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 24 deletions.
9 changes: 1 addition & 8 deletions docs/community.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,11 @@ who can answer your questions and help you out. Please do join us.
The two major places for community discussion are:

* `The mailing list <https://groups.google.com/forum/#!forum/hypothesis-users>`_.
* An IRC channel: #hypothesis on freenode.
* An IRC channel, #hypothesis on freenode, which is more active than the mailing list.

Feel free to use these to ask for help, provide feedback, or discuss anything remotely
Hypothesis related at all.

The IRC channel is the more active of the two. If you don't know how to use
IRC, don't worry about it. Just `click here to sign up to IRCCloud and log in <https://www.irccloud.com/invite?hostname=irc.freenode.net&channel=%23hypothesis>`_
(don't worry, it's free).

(IRCCloud is made by friends of mine, but that's not why I'm recommending it. I'm
recommending it because it's great).

---------------
Code of conduct
---------------
Expand Down
6 changes: 3 additions & 3 deletions docs/endorsements.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
========================
Who is using Hypothesis?
========================
============
Testimonials
============

This is a page for listing people who are using Hypothesis and how excited they
are about that. If that's you and your name is not on the list, `this file is in
Expand Down
12 changes: 6 additions & 6 deletions docs/packaging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ some information you might find useful.
Release tarballs
----------------

These are available from `the GitHub releases page <https://github.com/HypothesisWorks/hypothesis-python/releases>`_. The
tarballs on pypi are intended for installation from a Python tool such as pip or easy_install and should not
These are available from :gh-link:`the GitHub releases page <releases>`. The
tarballs on pypi are intended for installation from a Python tool such as pip and should not
be considered complete releases. Requests to include additional files in them will not be granted. Their absence
is not a bug.

Expand Down Expand Up @@ -53,9 +53,9 @@ Other Python libraries
Hypothesis has *optional* dependencies on the following libraries:

* pytz (almost any version should work)
* fake-factory (0.5.2 or 0.5.3)
* Django, 1.7 through 1.9 (This requires fake-factory to be installed)
* numpy, 1.10.x (earlier versions will probably work fine)
* faker, version 0.7
* Django, all supported versions
* numpy, 1.10 or later (earlier versions will probably work fine)
* py.test (2.7.0 or greater). This is a mandatory dependency for testing Hypothesis itself but optional for users.

The way this works when installing Hypothesis normally is that these features become available if the relevant
Expand Down Expand Up @@ -88,7 +88,7 @@ An example invocation for running the coverage subset of these tests:

.. code-block:: bash
python setup.py install
pip install -e .
pip install pytest # you will probably want to use your own packaging here
python -m pytest tests/cover
Expand Down
8 changes: 1 addition & 7 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -177,18 +177,12 @@ Hypothesis is `available on pypi as "hypothesis"
pip install hypothesis
or

.. code:: bash
easy_install hypothesis
If you want to install directly from the source code (e.g. because you want to
make changes and install the changed version) you can do this with:

.. code:: bash
python setup.py install
pip install -e .
You should probably run the tests first to make sure nothing is broken. You can
do this with:
Expand Down

0 comments on commit 436ad29

Please sign in to comment.