Skip to content

Commit

Permalink
Update documentation pertaining to PRAW4 prerelease status
Browse files Browse the repository at this point in the history
  • Loading branch information
bboe committed Nov 29, 2016
1 parent 120b43f commit 4db4033
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 16 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Expand Up @@ -13,7 +13,7 @@ participating in this project you agree to abide by its terms.
in the [praw-dev/praw](https://gitter.im/praw-dev/praw) channel on gitter.

0. Please check the
[Unreleased](https://github.com/praw-dev/praw/blob/praw4/CHANGES.rst#unreleased)
[Unreleased](https://github.com/praw-dev/praw/blob/master/CHANGES.rst#unreleased)
section of the latest changelog before filing an issue as it is possible the
issue has already been resolved.

Expand Down
11 changes: 4 additions & 7 deletions README.rst
Expand Up @@ -34,12 +34,9 @@ install PRAW is via `pip <https://pypi.python.org/pypi/pip>`_.

.. code-block:: bash
pip install --pre praw
pip install praw
.. note:: The ``--pre`` flag is needed to install PRAW4 as it is not yet the
official version.

To install the latest development version of PRAW4 run the following instead:
To install the latest development version of PRAW run the following instead:

.. code-block:: bash
Expand Down Expand Up @@ -100,7 +97,7 @@ Otherwise, there are a few official places to ask questions about PRAW:

`/r/redditdev <https://www.reddit.com/r/redditdev>`_ is the best place on
Reddit to ask PRAW related questions. This subreddit is for all Reddit API
related discussion so please tag submissions with *[PRAW4]*. Please perform a
related discussion so please tag submissions with *[PRAW]*. Please perform a
search on the subreddit first to see if anyone has similar questions.

Real-time chat can be conducted via the `praw-dev/praw
Expand Down Expand Up @@ -153,7 +150,7 @@ Bryce began work on PRAW4, a complete rewrite of PRAW.
License
-------

PRAW4's source is provided under the `Simplified BSD License
PRAW's source (v4.0.0+) is provided under the `Simplified BSD License
<https://github.com/praw-dev/praw/blob/0860c11a9309c80621c267af7caeb6a993933744/LICENSE.txt>`_.

* Copyright (c), 2016, Bryce Boe
Expand Down
10 changes: 2 additions & 8 deletions docs/getting_started/installation.rst
Expand Up @@ -6,10 +6,7 @@ PRAW is via ``pip``.

.. code-block:: bash
pip install --pre praw
.. note:: The ``--pre`` option is needed as PRAW4 is not yet the official
version.
pip install praw
.. note:: Depending on your system, you may need to use ``pip3`` to install
packages for python 3.
Expand All @@ -28,10 +25,7 @@ PRAW can be updated by running:

.. code-block:: bash
pip install --pre --upgrade praw
.. note:: The ``--pre`` option is needed as PRAW4 is not yet the official
version.
pip install --upgrade praw
Installing Older Versions
-------------------------
Expand Down

0 comments on commit 4db4033

Please sign in to comment.