Skip to content

Commit e20534c

Browse files
committed
Update docs in preparation of the stable 3.0.0 release
1 parent 4ed23ac commit e20534c

File tree

4 files changed

+7
-20
lines changed

4 files changed

+7
-20
lines changed

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@ Plays nicely with `graphene`, `graphql-core`, `graphql-js` and any other GraphQL
55

66
GQL architecture is inspired by `React-Relay` and `Apollo-Client`.
77

8-
> **WARNING**: Please note that the following documentation describes the current version which is currently only available as a pre-release
9-
> The documentation for the 2.x version compatible with python<3.6 is available in the [2.x branch](https://github.com/graphql-python/gql/tree/v2.x)
10-
118
[![GitHub-Actions][gh-image]][gh-url]
129
[![pyversion][pyversion-image]][pyversion-url]
1310
[![pypi][pypi-image]][pypi-url]
@@ -48,11 +45,11 @@ The complete documentation for GQL can be found at
4845

4946
## Installation
5047

51-
> **WARNING**: Please note that the following documentation describes the current version which is currently only available as a pre-release and needs to be installed with
48+
You can install GQL with all the optional dependencies using pip:
5249

53-
$ pip install --pre gql[all]
50+
pip install gql[all]
5451

55-
> **NOTE**: See also [the documentation](https://gql.readthedocs.io/en/latest/intro.html#less-dependencies) to install GQL with less extra dependencies
52+
> **NOTE**: See also [the documentation](https://gql.readthedocs.io/en/latest/intro.html#less-dependencies) to install GQL with less extra dependencies depending on the transports you would like to use
5653
5754
## Usage
5855

docs/index.rst

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,5 @@
11
Welcome to GQL 3 documentation!
2-
=================================
3-
4-
.. warning::
5-
6-
Please note that the following documentation describes the current version which is currently only available
7-
as a pre-release and needs to be installed with "`--pre`"
2+
===============================
83

94
Contents
105
--------

docs/intro.rst

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,7 @@ Installation
1212

1313
You can install GQL 3 and all the extra dependencies using pip_::
1414

15-
pip install --pre gql[all]
16-
17-
.. warning::
18-
19-
Please note that the following documentation describes the current version which is currently only available
20-
as a pre-release and needs to be installed with "`--pre`"
15+
pip install gql[all]
2116

2217
After installation, you can start using GQL by importing from the top-level
2318
:mod:`gql` package.
@@ -33,7 +28,7 @@ instead of using the "`all`" extra dependency as described above, which installs
3328
If for example you only need the :ref:`AIOHTTPTransport <aiohttp_transport>`,
3429
which needs the :code:`aiohttp` dependency, then you can install GQL with::
3530

36-
pip install --pre gql[aiohttp]
31+
pip install gql[aiohttp]
3732

3833
The corresponding between extra dependencies required and the GQL classes is:
3934

docs/usage/file_upload.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ It is also possible to upload multiple files using a list.
6060
''')
6161
6262
f1 = open("YOUR_FILE_PATH_1", "rb")
63-
f2 = open("YOUR_FILE_PATH_1", "rb")
63+
f2 = open("YOUR_FILE_PATH_2", "rb")
6464
6565
params = {"files": [f1, f2]}
6666

0 commit comments

Comments
 (0)