Skip to content

Commit a4e5778

Browse files
committed
Improve README file
1 parent 9d915b2 commit a4e5778

File tree

2 files changed

+23
-24
lines changed

2 files changed

+23
-24
lines changed

README.md

+21-22
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ a query language for APIs created by Facebook.
1010
![Lint Status](https://github.com/graphql-python/graphql-core/actions/workflows/lint.yml/badge.svg)
1111
[![Code Style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
1212

13-
An extensive test suite with over 2300 unit tests and 100% coverage comprises a
14-
replication of the complete test suite of GraphQL.js, making sure this port is
15-
reliable and compatible with GraphQL.js.
13+
An extensive test suite with over 2200 unit tests and 100% coverage replicates the
14+
complete test suite of GraphQL.js, ensuring that this port is reliable and compatible
15+
with GraphQL.js.
1616

17-
The current stable version 3.2.4 of GraphQL-core is up-to-date with GraphQL.js
18-
version 16.8.2 and supports Python version 3.6 to 3.12.
17+
The current stable version 3.2.5 of GraphQL-core is up-to-date with GraphQL.js
18+
version 16.8.2 and supports Python versions 3.6 to 3.13.
1919

20-
You can also try out the latest alpha version 3.3.0a6 of GraphQL-core
20+
You can also try out the latest alpha version 3.3.0a6 of GraphQL-core,
2121
which is up-to-date with GraphQL.js version 17.0.0a2.
2222
Please note that this new minor version of GraphQL-core does not support
2323
Python 3.6 anymore.
@@ -26,13 +26,12 @@ Note that for various reasons, GraphQL-core does not use SemVer like GraphQL.js.
2626
Changes in the major version of GraphQL.js are reflected in the minor version of
2727
GraphQL-core instead. This means there can be breaking changes in the API
2828
when the minor version changes, and only patch releases are fully backward compatible.
29-
Therefore, we recommend something like `=~ 3.2.0` as version specifier
29+
Therefore, we recommend using something like `~= 3.2.0` as the version specifier
3030
when including GraphQL-core as a dependency.
3131

32-
3332
## Documentation
3433

35-
A more detailed documentation for GraphQL-core 3 can be found at
34+
More detailed documentation for GraphQL-core 3 can be found at
3635
[graphql-core-3.readthedocs.io](https://graphql-core-3.readthedocs.io/).
3736

3837
The documentation for GraphQL.js can be found at [graphql.org/graphql-js/](https://graphql.org/graphql-js/).
@@ -47,10 +46,10 @@ examples.
4746

4847
A general overview of GraphQL is available in the
4948
[README](https://github.com/graphql/graphql-spec/blob/main/README.md) for the
50-
[Specification for GraphQL](https://github.com/graphql/graphql-spec). That overview
51-
describes a simple set of GraphQL examples that exist as [tests](tests) in this
52-
repository. A good way to get started with this repository is to walk through that
53-
README and the corresponding tests in parallel.
49+
[Specification for GraphQL](https://github.com/graphql/graphql-spec). This overview
50+
includes a simple set of GraphQL examples that are also available as [tests](tests)
51+
in this repository. A good way to get started with this repository is to walk through
52+
that README and the corresponding tests in parallel.
5453

5554

5655
## Installation
@@ -174,17 +173,17 @@ asyncio.run(main())
174173

175174
## Goals and restrictions
176175

177-
GraphQL-core tries to reproduce the code of the reference implementation GraphQL.js
178-
in Python as closely as possible and to stay up-to-date with the latest development of
179-
GraphQL.js.
176+
GraphQL-core aims to reproduce the code of the reference implementation GraphQL.js
177+
in Python as closely as possible while staying up-to-date with the latest development
178+
of GraphQL.js.
180179

181-
GraphQL-core 3 (formerly known as GraphQL-core-next) has been created as a modern
180+
GraphQL-core 3 (formerly known as GraphQL-core-next) was created as a modern
182181
alternative to [GraphQL-core 2](https://github.com/graphql-python/graphql-core-legacy),
183-
a prior work by Syrus Akbary, based on an older version of GraphQL.js and also
184-
targeting older Python versions. Some parts of GraphQL-core 3 have been inspired by
185-
GraphQL-core 2 or directly taken over with only slight modifications, but most of the
186-
code has been re-implemented from scratch, replicating the latest code in GraphQL.js
187-
very closely and adding type hints for Python.
182+
a prior work by Syrus Akbary based on an older version of GraphQL.js that still
183+
supported legacy Python versions. While some parts of GraphQL-core 3 were inspired by
184+
GraphQL-core 2 or directly taken over with slight modifications, most of the code has
185+
been re-implemented from scratch. This re-implementation closely replicates the latest
186+
code in GraphQL.js and adds type hints for Python.
188187

189188
Design goals for the GraphQL-core 3 library were:
190189

tox.ini

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ deps =
4949
pytest-timeout>=2.3,<3
5050
py3{7,8,9}, pypy39: typing-extensions>=4.7.1,<5
5151
commands =
52-
# to also run the time-consuming tests: tox -e py311 -- --run-slow
53-
# to run the benchmarks: tox -e py311 -- -k benchmarks --benchmark-enable
52+
# to also run the time-consuming tests: tox -e py312 -- --run-slow
53+
# to run the benchmarks: tox -e py312 -- -k benchmarks --benchmark-enable
5454
py3{7,8,9,10,11,13}, pypy3{9,10}: pytest tests {posargs}
5555
py312: pytest tests {posargs: --cov-report=term-missing --cov=graphql --cov=tests --cov-fail-under=100}

0 commit comments

Comments
 (0)